3 ms·

Nice! We tried using the Wiki of a gitlab project in my company to gather some knowledge in a single place, but it was too "hard" to go to a page and edit it.

Nice! We tried using the Wiki of a gitlab project in my company to gather some knowledge in a single place, but it was too "hard" to go to a page and edit it. So we moved the content in the repo. Again, we had to search if our content was already written or not, and we were spending time trying to find files and words instead of writing shorts texts. So we moved our content on the gitlab issues of the repo. Issues have the same markdown support, we can use ctrl+v to insert screenshots, we can add tags to the issues, we can assign people to relevant issues, we can comment with new things to do/add, and we can use the search bar to find relevant content. All our "knowledge doc" is stored insides the issues of an empty project named "doc". We were just thinking about something to replace an older system not used anymore, and since it's been 2 years I think I can say that issues really work well for us (small team, 6 devs, some of us write more issues than others). For personal notes I did what every dev do when they think about a problem ("Why not make my ideal tool myself?"), and I created n.py, a very small Python program that's used to take incremental notes using any program (I used sublime text, nano and now I'm learning vim through it), search in the notes content and display them (repo here: https://git.bitmycode.com/sodimel/n https://git.bitmycode.com/sodimel/n).

dnsmichi 4y ago
GitLab team member here, thanks for sharing your experience! The UX with editing the wiki, using WYSIWYG content editor [0] has been improved in recent releases. [1] I peeked into 15.2 (self-managed release coming on Friday, July 22) which brings rendering Mermaid, PlantUML, Kroki diagrams previews. [2] Maybe the wiki can be worth to revisit in the future, there are more features underway, suggest diving into this epic [3] > Issues have the same markdown support, we can use ctrl+v to insert screenshots, we can add tags to the issues, we can assign people to relevant issues, we can comment with new things to do/add, and we can use the search bar to find relevant content. All our "knowledge doc" is stored insides the issues of an empty project named "doc". Great to see that you have found a workflow, and use issues to keep things documented and organized. Maybe a suggestion for creating an entry point into the dcc project: Use GitLab CI/CD to read the issues from the REST API, group by label, and render a Markdown README.md file which gets pushed to the repository automatically. That way the "index" is generated and provides greater visibility into the documentation issues. I like API challenges, so I've hacked [4] a small script [5] using python-gitlab to better illustrate what I mean :-) Uses issues [6] with labels to generate an index.md [7] (can also be README.md for example). Feel free to repurpose for your own needs, if that helps. The missing step is to automate it using GitLab CI/CD Schedules, but that's documented. [0] https://docs.gitlab.com/ee/user/project/wiki/#content-editor https://docs.gitlab.com/ee/user/project/wiki/#content-editor [1] https://about.gitlab.com/releases/2022/05/22/gitlab-15-0-released/#edit-code-blocks-links-and-media-inline-in-the-wysiwyg-editor https://about.gitlab.com/releases/2022/05/22/gitlab-15-0-rel... [2] https://gitlab.com/gitlab-org/gitlab/-/merge_requests/86701 https://gitlab.com/gitlab-org/gitlab/-/merge_requests/86701 [3] https://gitlab.com/groups/gitlab-org/-/epics/5401 https://gitlab.com/groups/gitlab-org/-/epics/5401 [4] https://gitlab.com/dnsmichi/api-playground/-/merge_requests/9 https://gitlab.com/dnsmichi/api-playground/-/merge_requests/... [5] https://gitlab.com/dnsmichi/api-playground/-/tree/main/python#issue-index-creation https://gitlab.com/dnsmichi/api-playground/-/tree/main/pytho... [6] https://gitlab.com/dnsmichi/api-playground/-/issues https://gitlab.com/dnsmichi/api-playground/-/issues [7] https://gitlab.com/dnsmichi/api-playground/-/blob/main/index.md https://gitlab.com/dnsmichi/api-playground/-/blob/main/index...
- whoibrar 4y ago
  Everytime I see someone from a company actually caring to help out users even befor asking brings little joy :)

dnsmichi 4y ago

GitLab team member here, thanks for sharing your experience! The UX with editing the wiki, using WYSIWYG content editor [0] has been improved in recent releases. [1] I peeked into 15.2 (self-managed release coming on Friday, July 22) which brings rendering Mermaid, PlantUML, Kroki diagrams previews. [2] Maybe the wiki can be worth to revisit in the future, there are more features underway, suggest diving into this epic [3] > Issues have the same markdown support, we can use ctrl+v to insert screenshots, we can add tags to the issues, we can assign people to relevant issues, we can comment with new things to do/add, and we can use the search bar to find relevant content. All our "knowledge doc" is stored insides the issues of an empty project named "doc". Great to see that you have found a workflow, and use issues to keep things documented and organized. Maybe a suggestion for creating an entry point into the dcc project: Use GitLab CI/CD to read the issues from the REST API, group by label, and render a Markdown README.md file which gets pushed to the repository automatically. That way the "index" is generated and provides greater visibility into the documentation issues. I like API challenges, so I've hacked [4] a small script [5] using python-gitlab to better illustrate what I mean :-) Uses issues [6] with labels to generate an index.md [7] (can also be README.md for example). Feel free to repurpose for your own needs, if that helps. The missing step is to automate it using GitLab CI/CD Schedules, but that's documented. [0] https://docs.gitlab.com/ee/user/project/wiki/#content-editor https://docs.gitlab.com/ee/user/project/wiki/#content-editor [1] https://about.gitlab.com/releases/2022/05/22/gitlab-15-0-released/#edit-code-blocks-links-and-media-inline-in-the-wysiwyg-editor https://about.gitlab.com/releases/2022/05/22/gitlab-15-0-rel... [2] https://gitlab.com/gitlab-org/gitlab/-/merge_requests/86701 https://gitlab.com/gitlab-org/gitlab/-/merge_requests/86701 [3] https://gitlab.com/groups/gitlab-org/-/epics/5401 https://gitlab.com/groups/gitlab-org/-/epics/5401 [4] https://gitlab.com/dnsmichi/api-playground/-/merge_requests/9 https://gitlab.com/dnsmichi/api-playground/-/merge_requests/... [5] https://gitlab.com/dnsmichi/api-playground/-/tree/main/python#issue-index-creation https://gitlab.com/dnsmichi/api-playground/-/tree/main/pytho... [6] https://gitlab.com/dnsmichi/api-playground/-/issues https://gitlab.com/dnsmichi/api-playground/-/issues [7] https://gitlab.com/dnsmichi/api-playground/-/blob/main/index.md https://gitlab.com/dnsmichi/api-playground/-/blob/main/index...

whoibrar 4y ago
Everytime I see someone from a company actually caring to help out users even befor asking brings little joy :)