Hello @sig_documentation! I’m pleased to announce that, as discussed in yesterday’s call, we’re running a Wiki.js instance at https://wiki.auxolotl.org/. It’s also synchronized to GitHub - auxolotl/wiki
Let’s get started on writing documentation! It would be excellent if we could use this thread to coordinate what to write.
Also as per yesterday’s call I have licensed the content under the MIT License, so provided we include the copyright notice Copyright (c) 2017 Jörg Thalheim we are not breaking the terms of The NixOS Wiki if we build on their work. Similarly, we can contribute back to the NixOS Wiki.
27 Likes
Amazing work guys!
Can’t wait to see everyone’s notes.
Maybe I shall write up some release schedule stuff.
Just curious about contributions. Do we make them to the GitHub repo?
1 Like
You can make them either to GitHub or directly on the Wiki. The sync is two-way
3 Likes
I tossed a few ideas down in https://auxdocs.foss.life/ - a landing page and framework for a Getting Started guide. I’ll see if I can transfer those over.
2 Likes
I’ve fixed that now, thanks!
1 Like
For my part, I’d like to start documenting things like “what is a SIG? what committees & sigs are there, what do they do, when do they meet” etc.
I’ll take a look at the K8s community repo, and I’m certain that some of this would fit in our community repo, but for now I think it’s crucially important that documenting this sort of thing isn’t missed
6 Likes
It would also be nice to add a section on how to contribute to the wiki. Something like Introduction to Wiki.js | Wiki.js perhaps?
Also, is it possible to hide the left bar (Global Navigation)?
2 Likes
Excellent idea! Would you like to do that or shall I?
Unfortunately I think it’s not, unless you completely disable it. Perhaps we should look into writing some Javascript to add this functionality?
2 Likes
I asked because I don’t know how, but I can give it a shot.
3 Likes
That sounds excellent then, please feel free to ask for help from me if you need any!
3 Likes
Is there a quick way to run the wiki locally?
1 Like
Sadly not, why do you need to? You should be able to see a preview as you edit a page on the Wiki, so long as you aren’t using GitHub to upload files directly
1 Like
Ah, I see. I was thinking of using GitHub. Thanks.
1 Like
The raw Markdown is stored here. As far as previewing goes, maybe we could create a shell.nix to spin up a local version of Wiki.js?
3 Likes
I’m logged in, but I can’t create a new page from the editor:
Are you signed in with GitHub? If so, what is your account?
ahh, excellent, I’m glad it’s working now
2 Likes
