Doc Cleanup for 6.2 Release
Opened this issue · 5 comments
@georgejhunt is working on Release Notes @ 254398c
@holta is working on FAQ @ http://schoolserver.org/FAQ and https://github.com/XSCE/xsce/wiki/XSCE-Installation thanks to input from many.
@tim-moody can help bring https://github.com/XSCE/xsce/wiki/XSCE-Menuing and https://github.com/XSCE/xsce/wiki/XSCE-Networking-Overview up-to-date I hope!
Some consensus should be hashed out (during our Thur 10:30AM EST call tmrw with @m-anish & all?) about what exactly to say around CentOS 7.3 experimental support/testing needs still evolving @ https://github.com/XSCE/xsce/wiki/XSCE-Platforms (and the possibility of Fedora being less actively supported going forward, depending on volunteers!)
Finally all can+should assist highlighting the very best 2014-2016 legacy materials from https://github.com/XSCE/xsce/tree/release-6.2/docs to https://github.com/XSCE/xsce/wiki
Also needed/very useful would be:
- clarifications from @floydianslips on where ownCloud v. Nextcloud vs Sandstorm.io community support consolidating is going!
- deprecations/additions @ "What technical documentation exists?" (http://schoolserver.org/FAQ # 18 ...which docs best to remove/insert?!)
- a bit more precision as to which images contain what in places like http://xsce.org/downloads/xsce-release-6.2/rpi/ (not a red carpet, but the most brief comparison of best/available images would be great!)
@georgejhunt has created a great offline repo of Internet-in-a-Box installer/maintenance docs with @tim-moody's help over the past week, automatically scraping https://github.com/xsce/xsce/wiki into HTML.
Let's try to add in these 2 docs also: (great installer vids etc expected later!)
- HTML from http://schoolserver.org/faq
- PDF from Nick Doiron's beautiful "how do I plug it in?" illustrations @ https://docs.google.com/presentation/d/1MMg5Wt3srDZgsAZxkLpLdMLhiCy4F02URY_cjAIJFp0/edit
How often can George's HTML doc-scraper be run, ideally on a predictable monthly, weekly, daily schedule? Or quasi-live possibly, to reflect the latest changes, always being added to the source online wiki-based docs?
In Any Case: short link should be http://box/info so field-operators / techie-teachers / everyone can all find these "survival guide docs" in the field, even if worst case xsce-admin password's been lost etc!
PS many countries were surveyed in choosing the above link (http://box/info). Non-English speakers generally favored the word "info" over {sos, help, start, guide, instructions, etc} as the word "info" does not need translation into 40+ languages worldwide. The same could be argued for the term "docs" but http://box/docs is being reserved as a mnemonic shortcut for kids/teachers wanting to instantly create their own docs using @floydianslips's upcoming PR installing http://Nextcloud.com (similar to ownCloud, but more broadly community supported) as part of IIAB.
STATUS:
- http://box/info (offline library of IT docs/vids) built by @georgejhunt ; we'll discuss PDF/video additions to that (and http://schoolserver.org/faq scraping) in LA next week!
- https://github.com/xsce/xsce/wiki now has 7 docs, far better polished than a week ago.
- we'll sanitize https://github.com/XSCE/xsce/wiki/IIAB-Installation from top to bottom with @Darkenvy when we meet in LA next week, as it's grown in too many directions (thanks to @floydianslips who keeps hammering on install images @ http://xsce.org/downloads/xsce-release-6.2/rpi/ just as we need!!)
- https://github.com/XSCE/xsce/wiki/IIAB-Platforms cleaned up nicely by @floydianslips, but let's give this a once-over / official sanctioning when we meet in LA next week.
- TCP/UDP ports list cleaned up @ https://github.com/XSCE/xsce/wiki/IIAB-Networking thanks to James Cameron & All
- local_vars.yml clarified by @tim-moody @ https://github.com/XSCE/xsce/wiki/IIAB-Architecture (example will be added later)
- if @tim-moody can give a complete walk-thru demo/tutorial of https://github.com/xsce/xsce/wiki/IIAB-Menuing next week in LA, that's be incredible, to the entire group!
Collection Clarif/Summary, as we & @georgejhunt "offline" (that is, scrape & convert) all the best IT docs/vids, for offline assistance via http://box/info. Our basic needs are these 4 for now:
- the 6+1 docs @ https://github.com/xsce/xsce/wiki
- http://schoolserver.org/FAQ is not just 1 monolithic/long doc of 24 (and counting!) FAQ's, but should also include:
http://wiki.laptop.org/go/XS_Community_Edition/Security
http://wiki.laptop.org/go/XS_Community_Edition/local_vars.yml
http://wiki.laptop.org/go/XS_Community_Edition/Features/Startup_sound - Nick Doiron's 5-pager "unboxing" schematic: https://docs.google.com/presentation/d/1MMg5Wt3srDZgsAZxkLpLdMLhiCy4F02URY_cjAIJFp0/edit
- install vid(s) in future!
STATUS / UPDATE since 6 weeks ago:
- https://github.com/xsce/xsce/wiki now has 8 docs (Tim helped clean up "IIAB Variables")
- many important fixes+clarifs added to http://schoolserver.org/FAQ
- Offline IT support docs are scraped very nicely into http://box/info thanks to George making serious improvements here. In addition to the 9 docs above, he has also included these 2:
- http://wiki.laptop.org/go/XS_Community_Edition/Security
- http://wiki.laptop.org/go/XS_Community_Edition/local_vars.yml
CONCLUSION: we're almost ready for release, thanks to so many critical issues resolved in recent weeks, and documentation tracking current features more than ever before!