AGL Documentation Site: '-next' preview available

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Hi all,

We have some good news: the reworking on AGL documentation site has reached a significant step and it's now time to share the upcoming site with the community.


The 'next' documentation site is available for preview at the following address:

http://docs.automotivelinux.org/next/

Important note: the original site is left unchanged for now. See at the end for roadmap.


Major changes on the '-next' site :

* As you may know, Scott Rifenbark started to review/rewrite/organize some sections, such as "Getting Started". This is still a work in progress and the goal is to have all existing documents covered.

* Documentation pages now propose a handy selector at the top right of the page to select the AGL release:

* Multi-language support is ready but not tested (translated documents are missing ;-)).

* New top sections "HowTo" and "Reference" have been created to anticipate a content reorganization where each audience will find the appropriate documents more easily. A document to explain how to write documentation for AGL is currently under writing. When ready, it will be a first-class citizen in the HowTo section!

* Under the hood: the site generation workflow has evolved and YAML files describing the documentation for each individual git repository can now be used instead of a global monolithic catalog. If you're a repo maintainer, you should have noticed that some files named "doc/mybook.yml" like this one on the AppFW binder have been pushed recently in the sources repositories. These "books.yml" files let the developers organize "their" documentation content without having to commit on the documentation website template. As a consequence, doc site maintainers can now easily organize "books" on the website (and don't have to deal with all chapters for all books in a global complex ugly list!). Said shortly, duties are now better identified and separated.

* For non component-based documentation (getting started guides, security blueprint etc.): docs-agl has been deprecated in favor of the new repo docs-sources . For any adjustment on these guides, please push PRs on the new repository docs-sources, in the appropriate branch depending on the affected AGL release (master, guppy, flounder, ...). For changes on the web site itself (layout, CSS, global templating), contributions on docs-webtemplate are also welcome.

* As a reminder: for any document on the site, the source url used to generate the content + the generation timestamp can be found by looking at the page footer. Mentioning the source when sending comments will help to solve the issues faster (and most of the time, issues can be fixed by the documentation writers themselves).

* and many other minor enhancements...


We expect to switch docs.automotivelinux.org to this new site very soon, ideally after developer meeting on next Thursday (March 26th) if there are no blockers.

Therefore, your reviews and suggestions are highly appreciated, so we can fix the last bits before migrating.


Best regards,

---
Stephane Desneux - CTO - IoT.bzh
stephane.desneux@xxxxxxx - www.iot.bzh

_______________________________________________
automotive-discussions mailing list
automotive-discussions@xxxxxxxxxxxxxxxxxxxxxxxxx
https://lists.linuxfoundation.org/mailman/listinfo/automotive-discussions

[Index of Archives]     [LARTC]     [Bugtraq]     [Yosemite Forum]     [Photo]

  Powered by Linux