Ancestors

Toot

Written by Eric Normandeau on 2024-11-12 at 17:18

I'm looking for a lightweight, private, and open source way to share internal documentation for our service platform's team.

I was thinking maybe a gitlab repo and markdown files. I would prefer that we host everything.

Do you have any suggestion or experience to share?

Please boost!

[#]bioinformatics #documentation #opensource

=> More informations about this toot | More toots from eric_normandeau@genomic.social

Descendants

Written by Jake in the desert on 2024-11-12 at 17:24

@eric_normandeau if it was me, I'd go Codeberg.

=> More informations about this toot | More toots from jake4480@c.im

Written by Eric Normandeau on 2024-11-12 at 17:28

@jake4480 Cool, I didn't know about Codeberg. I'd prefer if we hosted the solution (editing original message).

=> More informations about this toot | More toots from eric_normandeau@genomic.social

Written by Jake in the desert on 2024-11-12 at 17:29

@eric_normandeau ohh ok yeah - self hosted will be different. Yeah, Codeberg is a great alternative to Github.

=> More informations about this toot | More toots from jake4480@c.im

Written by M. Forester on 2024-11-12 at 18:29

@jake4480 @eric_normandeau Codeberg basically runs a slightly customized and themed version of Forgejo. It's super easy to set up and manage.

https://forgejo.org/

I'd recommend it over GitLab, because the latter is way more complex and comes with a ton of stuff that you'll probably never need. 🙂

If everybody's fine with Markdown a private Git repo is the way to go.

=> More informations about this toot | More toots from mforester@rollenspiel.social

Written by Tomi on 2024-11-12 at 17:25

@eric_normandeau if you like to #selfhost I recommend #bookstack or any wiki system. You can run it on #docker an lock access to internal network

=> More informations about this toot | More toots from xanderekpl@tech.lgbt

Written by Eric Normandeau on 2024-11-12 at 17:30

@xanderekpl Thank you. It looks like an interesting option. I'll check the doc and features.

=> More informations about this toot | More toots from eric_normandeau@genomic.social

Written by 🦇💩🤪🏳️‍⚧️👧🏽 on 2024-11-12 at 17:30

@eric_normandeau If they are developers, that solution has worked for me (With Gitlab, which I found more functional for such). But if there are any non-developers, it quickly falls apart for me.

=> More informations about this toot | More toots from CumVampire@chaosfem.tw

Written by Eric Normandeau on 2024-11-12 at 17:33

@CumVampire All are bioinformaticians and there is a sysadmin. Does gitlab have an option to edit a file directly in a WYSIWYG editor like GitHub? That could potentially help accessibility for the less terminal-oriented member of the team.

=> More informations about this toot | More toots from eric_normandeau@genomic.social

Written by 🦇💩🤪🏳️‍⚧️👧🏽 on 2024-11-12 at 18:03

@eric_normandeau It does, and I've found it overall to be much more functional in that regard.

Disclaimer, this was about 3-4 years ago now, so Github may have advanced. But overall, the Gitlab system was Fire.

=> More informations about this toot | More toots from CumVampire@chaosfem.tw

Written by Dennis Reichenberg on 2024-11-12 at 17:34

@eric_normandeau We used mkdocs in the past. You basically write markdown files, compile them to a static HTML page and then throw them into some webserver like nginx. https://www.mkdocs.org/ Was pretty neat.

=> More informations about this toot | More toots from dennis@bananen.software

Written by Eric Normandeau on 2024-11-12 at 17:35

@dennis I like that! Added to the list of interesting solutions!

=> More informations about this toot | More toots from eric_normandeau@genomic.social

Written by Jean-Sébastien Guay on 2024-11-12 at 17:41

@eric_normandeau If your writers are technical, Markdown in a self-hosted version control system is a good choice IMHO. You can't beat the speed and merge-ability of plain text.

I like using Markdeep myself, you write Markdown but then you can open the file in a browser and it gets beautiful formatting (and it supports lots of useful stuff beyond regular Markdown).

https://casual-effects.com/markdeep/

=> More informations about this toot | More toots from skylark13@mastodon.gamedev.place

Written by Mike Zornek on 2024-11-12 at 17:45

@eric_normandeau If you are on GitHub Enterprise you can make a repo with markdown and publish it to a website.

The GitHub enterprise is helpful in limiting access to said webpage to those who already Repo access.

Good luck.

https://docs.github.com/en/enterprise-cloud@latest/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site#about-access-control-for-github-pages-sites

=> More informations about this toot | More toots from zorn@jawns.club

Written by Eric Normandeau on 2024-11-12 at 17:51

@zorn Thank you. I am trying to avoid GitHub for this. I'd rather we self-host the solution.

=> More informations about this toot | More toots from eric_normandeau@genomic.social

Written by Mike Zornek on 2024-11-12 at 19:06

@eric_normandeau Ok. Well I've used Render to host static sites that are generated through Hugo if you want another option to consider. 👍

https://docs.render.com/static-sites

=> More informations about this toot | More toots from zorn@jawns.club

Written by Gerrit Niezen on 2024-11-14 at 07:03

@eric_normandeau mkdocs? And if you want a framework on top: https://squidfunk.github.io/mkdocs-material/

=> More informations about this toot | More toots from gendor@merveilles.town

Written by Eric Normandeau on 2024-11-14 at 11:53

@gendor You're the second to suggest mkdocs and I quite like the look of that. I remember learning about Material for MkDocs a while back but I had completely forgotten about it. Thanks!

=> More informations about this toot | More toots from eric_normandeau@genomic.social