top | item 37899302

(no title)

HHad3 | 2 years ago

We've moved to plain markdown in Git(Lab) as Confluence replacement. A CI pipeline compiles it to HTML and hosts it on the web via Material for MkDocs.

It lacks most collaboration options for non-developer users, but we found that they are rarely, if at all, used anyway. Non-developer users can still use an edit button that points to GitLab's web editor and update the docs that way.

I can't suggest a replacement for Jira at this point. I don't think there is one tool to recommend that fits every company's workflow. The other comments seem to have some nice tools to try.

discuss

order

dnsmichi|2 years ago

GitLab team member here, thanks for sharing.

> It lacks most collaboration options for non-developer users, but we found that they are rarely, if at all, used anyway. Non-developer users can still use an edit button that points to GitLab's web editor and update the docs that way.

Maybe the wiki in GitLab provides a possible path forward. https://docs.gitlab.com/ee/user/project/wiki/

The wiki uses the same Rich Text editor as known from issue/MR comments, aiding visual editing with context actions - for example, Markdown tables, rows, columns, or uploading and resizing images.

> Material for MkDocs.

I personally love this project. I'm using it for o11y.love and opsindev.news published via GitLab pages. Editing happens mainly in the browser, using the Web IDE.

Sources in case you are interested:

https://gitlab.com/everyonecancontribute/observability/o11y....

https://gitlab.com/dnsmichi/opsindev.news

PS: Tip for faster editing files using the Web IDE in the browser: Press `.` on a repository view which opens the Web IDE immediately.

galangalalgol|2 years ago

Gitlab and github are a lot more than simple markdown. They support a lot of additions like equations, and mermaid graphs. The only thing I've used confluence for that won't work in out of the box gitlab is a circuit diagram. And the right way to do that was probably to have the pipeline generate an svg from the circuit simulation model, not draw it.