[AusNOG] FOSS Documentation for mixed use-cases?

[James Hodgkinson]

mkdocs isn't bad, mdbook from the rust community is pretty great and has some good plugins/options. Both of them can work with Github Actions to publish to a variety of places like s3 buckets or github pages if you want things to be accessible. 

There's also hugo and zola for static site generation but they're less focused on docs and more generic.

On 2023-12-12 10:01 Luke Thompson wrote:
> G'day folks,
> 
> This year's been a long road of final ground-works for us, and I'm working to get a few more long-term nails bedded down before it's 2024. Eliminating Atlassian from our vendor stack is one of them.
> 
> We left Jira a while back for GitHub Project/Issues (not ideal, but we're constantly refining it and do a lot on there already), though Confluence Cloud is simple, good looking, and as of very recently, somewhat stable (ie. less awful than it was long-term following the re-build) and has been our Docs go-to since day 1.
> 
> I'd really like to shift this over to an open-source solution, and had been looking at Mkdocs over time though it's got that slightly rough open-source feeling to it, though brilliant, and recently stumbled upon a nice documentation site which was powered by Mkdocs-Material by Martin Donath & community.
> 
> 
> 
> https://github.com/squidfunk/mkdocs-material
> Base of: https://www.mkdocs.org/
> 
> 
> Python isn't our ideal; we're primarily PHP-driven at the moment while we keep evaluating a lower-level language to commit to fundamentally (Rust, Python, Ruby, Perl, etc). That's a slow-burn process for us, so at the moment Python would be a decent compromise - though PHP is our preference for a few reasons (namely for simplicity to internally deploy).
> 
> Does anyone have experiences, check this, avoid that, sort of feedback that they're happy to share? We'd be incredibly grateful!
> 
> A couple of others from my GitHub starred list:
> 
> 
> 
> https://github.com/facebook/docusaurus
> https://github.com/BookStackApp/BookStack
> 
> 
> Feels like yesterday (10~ years ago) I was leaving uni and joining web host #2 for $40k/year inc super... hard lessons must be learnt - don't tell them you're happy with the pay of your previous job! Now the kids are 6 & 2, and 2024's knocking on the door. Wild.
> 
> *(Also, quick plug for Mozilla Thunderbird - has now had a visual redo as of v115 "Supernova" - worth a sticky beak!)
> https://blog.thunderbird.net/2023/07/our-fastest-most-beautiful-release-ever-thunderbird-115-supernova-is-here/*
> 
> Many thanks in advance for any recommendations, thoughts, etc. :-)
> 
> 
> 
> 
> 
> Cheers,
> Luke
> 
> 
> _______________________________________________
> AusNOG mailing list
> AusNOG at lists.ausnog.net
> https://lists.ausnog.net/mailman/listinfo/ausnog
> 
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.ausnog.net/pipermail/ausnog/attachments/20231212/225b20d8/attachment.htm>