amtgard / ORK3

Version 3 of the Online Record Keeper
Other
23 stars 10 forks source link

Add an mkdocs directory and output directory for ORK users documentation #247

Closed kenwalker closed 3 years ago

kenwalker commented 4 years ago

This is a suggestion to use mkdocs as a means to generate documentation for the ORK. We're using it at work and it's quite reasonable. This would make writing doc accessible to all since it's markdown and images. mkdocs also generates an index for searching.

The workflow would be for changes to be made in an mkdocs subdirectory and the output of the "mkdocs build" would go into a statically served directory on the ORK proper. I can do some prototyping and add some screenshots to this issue to show what it might look like.

Has any other documentation effort tied to the ORK been thought of before?

The mkdocs site itself

Glenalth commented 4 years ago

Kind of.... My initial plan for documentation was to crowd source through Google Docs and then link it directly from the ORK, but it turns out people aren't interested in helping write the documentation so it's sat with no edits for over a year now.

If it were built into the ORK with a note that it could be improved/edited it may draw some more attention.

https://docs.google.com/document/d/18wsfFoyD6RXrO4FAxXjfHRTQ0Z_4mWZqzI5f3aH0sNw/edit

kenwalker commented 4 years ago

I may do a trial with your initial content and see what you think it looks like in the mkdocs look/feel. Thanks for trying, I didn't know anything about this myself. And thanks for starting the doc.

jrtaylor-com commented 3 years ago

Requiring more storage space and processing (static site generation) will likely have an impact on the hosting finances and would require review and approval.

For now, I can easily throw in @Glenalth 's doc link. PR will be attached shortly.

kenwalker commented 3 years ago

Will review the other PR. I still thing an integrated documentation solution is required and should be brought up if you think it will impact hosting fee increase.

jrtaylor-com commented 3 years ago

I agree, an interactive help system and documentation built into the template would be great. But PR #259 is a stopgap until that can be added.