Extending the current documentation and wiki about asteroidos.org HOT 5 CLOSED

1. visually coherent and pleasing design

Yup. Note that if we find a wiki which doesn't look too trashy, I'd be happy to have everything be a wiki.

2. allow arbitrary hyperlinks to both internal pages and external sites

We could call it the web.

3. provide some clues for navigation (e.g. current sidenav and top menu)

I think they are nice yeah.

4. allow for text, pictures, movies integration
5. support data-driven page creation/maintenance (e.g. our current json to install pages thing)

In the worst case scenario we could have scripts that update pages based on checked-in json configs. Also as we step towards more and more detailed info (like your kernel version PR generated out of an awk query) it could also be good to dynamically generate these jsons.

No need to over-engineer things if there's no need but I'm saying, we could probably do various things.

6. support some means for a user, disconnected from the internet, to use a local clone (as with current containerization)

If the wiki system we choose is as good as it promises, I don't think this would be super important.

7. provide reasonably good security
8. support customization
9. access control and logging to know who changed what and when

Probably some amount of built-in spam filtering would be good yes.

10. support review/rollback of suggested edits
11. allow users to be able to add/correct content without being programmers or git experts
12. tools/technologies should be long-lasting and well supported
13. all tooling is FOSS
14. enable possible future web extensions such as watch-face creation tool

I wouldn't stress too much this one. We already have "fake" extensions to the website like https://log.asteroidos.org/ (which grew out of sync but I'm saying it's not the end of the world, I don't mind too much if rarely accessed pages are a bit out of sync)

15. provide a clear and rational architecture
16. enable/support/provide a unit test framework for customizations
17. serve pages that look good on computers, tablets, phones (and maybe watches at some point?)
18. support internationalization
19. enable/support/provide access logging
20. enable/support/provide error logging

from asteroidos.org.

Having discussed with @beroset . He mentioned we could maybe convert the whole website into a wiki.
And i think that is a tempting idea.
If we implement a wiki into the current website. It will be the largest piece of content anyway.
The documentation, install and FAQ pages could easily be a wiki.
Leaving 5 pages that make up the website being not wiki related.

But imho one strong point of our current website are the auto generated install pages.
How would we implement such things into a wiki, usual wikis would result in much text duplication?
Ideally, if we touch everything, can we have sort of a watch database where we generate the articles from and maybe have a decent search feature for watch spec details?

from asteroidos.org.

Here are some ideas for requirements for however we do it. Note that the numbering is solely for convenience in talking about individual points and is not intended to reflect any kind of prioritization.

Proposed requirements

1. visually coherent and pleasing design
2. allow arbitrary hyperlinks to both internal pages and external sites
3. provide some clues for navigation (e.g. current sidenav and top menu)
4. allow for text, pictures, movies integration
5. support data-driven page creation/maintenance (e.g. our current json to install pages thing)
6. support some means for a user, disconnected from the internet, to use a local clone (as with current containerization)
7. provide reasonably good security
8. support customization
9. access control and logging to know who changed what and when
10. support review/rollback of suggested edits
11. allow users to be able to add/correct content without being programmers or git experts
12. tools/technologies should be long-lasting and well supported
13. all tooling is FOSS
14. enable possible future web extensions such as watch-face creation tool
15. provide a clear and rational architecture
16. enable/support/provide a unit test framework for customizations
17. serve pages that look good on computers, tablets, phones (and maybe watches at some point?)
18. support internationalization
19. enable/support/provide access logging
20. enable/support/provide error logging

from asteroidos.org.

Fwiw, dodo did some more lobbying on the topic of getting a wiki and asked me to bump this thread with my latest comments on the aesthetic of the wiki, so, quoted from our chat:

Re theming, I'm fairly sure that if we keep the theming for later, it will just never happen. But I suppose that if others are fine with this then so be it. I also don't think we should necessarily block something useful on forcing someone into writing a chunk of CSS first (surely the Geneva convention must say something against coercing people into writing CSS)[...] Essentially I feel rather neutral about all of this. I don't have the motivation to either fight for nor against it at the moment and I also don't have the time to help make it happen so whatever happens will probably be fine by me and I'm happy with whatever the other maintainers say

from asteroidos.org.

Almost all of the proposed requirements have been met and we now have a functioning wiki: https://wiki.asteroidos.org/index.php/Documentation

from asteroidos.org.