Operation Make the Wiki Pretty!

[detron]

@meleu said in Operation Make the Wiki Pretty!:

@detron if your concern is about stressing the server, you can also use the --wait option. For example --wait=2 to wait 2 seconds between each retrieval. ;-)

that sounds even better. I will do this on my next reboot (in Windows for school. CHFI uses .pdf files that REQUIRE Adobe Acrobat due to protections) really funny since most of the work done with CHFI is in Linux. Same problem when I did the Certified Ethical Hacker Certification.

[herb_fargus]

@detron I had considered using readthedocs as it has options for html/PDF/epub export along with versioning but I didn't want to go through the hassle of converting markdown to restructured text. It would have been prohibitive especially if we want the community to continue to contribute to the wiki. Markdown is much simpler.

The process for creating the static pages is relatively simple through some parsing. Basically we clone the GitHub wiki repo, parse the markdown to HTML and generate the static pages through makedocs with minor configs/css etc.

@BuZz actually created a useful module that can be run manually that will generate the docs locally.

Source here:

https://github.com/RetroPie/RetroPie-Setup/blob/master/scriptmodules/admin/wikidocs.sh

sudo ~/RetroPie-Setup/retropie_packages.sh wikidocs depends

sudo ~/RetroPie-Setup/retropie_packages.sh wikidocs sources

sudo ~/RetroPie-Setup/retropie_packages.sh wikidocs build

sudo ~/RetroPie-Setup/retropie_packages.sh wikidocs install

Should generate a folder of the static pages in ~/RetroPie-Setup/tmp/build/wikidocs I believe ( or something like that, don't have access to my pi to check

The upload function is what we use to push updates to our server but requires an ssh key, a server side script runs the builds automagically though so we don't have to push updates manually.

[detron]

@herb_fargus

thank you for explanation, and the wonderful work done on RetroPie, in all of its parts.

the fact that all replies to my inquiry were detailed really shows how wonderful this community is.

thank you everyone

[meleu]

@herb_fargus hey herb, I'm using what you did here to get some inspiration for another project documentation and I have a question: did you edited/created the mkdocs.yml from scratch by hand? (notably the pages: section).

[herb_fargus]

@meleu yes. But parts can be batch generated from the GitHub wiki list

[meleu]

@herb_fargus thanks, I noticed that and your work is being very helpful.

Are you OK if I use what you wrote for Editing the Wiki on my repo wiki too?

The documentation project I'm starting is RetroAchievements related.

[herb_fargus]

@meleu by all means. If you're really ambitious readthedocs has greater functionality to export to epub PDF etc but it's based on rst instead of md so it's a little less intuitive.

[meleu]

@herb_fargus by the way, we added some valuable info in the emulationstation wiki a few weeks ago and it's not on the official docs. Please, let me know if I can help to update docs in some way. ;)

[BuZz]

@meleu It would be polite to check with the web host / admin (me) before telling people to spider the site. The server is busy enough as it is serving up users etc.

Please use @herb_fargus method for generating the docs locally.

[meleu]

@buzz I edited the post. But I can't edit the @detron 's reply. He quoted my post.