Adjust documentation site for Flounder
Description
Environment
relates to
Activity
@Jan-Simon Moeller: did you take a look at https://gerrit.automotivelinux.org/gerrit/18553 (those are the last bits missing for flounder doc)?
I think we can then close this issue and follow up on https://lf-automotivelinux.atlassian.net/browse/SPEC-2044#icft=SPEC-2044.
Tadaaa. So it was just a question of updating the CNAME file in the repo ?
Wait a little (coffee++) until DNS caught up.
http://docs-next.automotivelinux.org should resolve then .
Old site (https://github.com/automotive-grade-linux/docs-agl/tree/gh-pages) and new site (https://github.com/automotive-grade-linux/docs-gh-pages) seem equivalent (the repo name is not added in the base URL).
For example, on the "old" site, you can see that the site root is '/', as here: https://github.com/automotive-grade-linux/docs-agl/blob/af081a551ccd333d8686292316754006120dbd12/index.html#L68
So the only visible difference I can see is:
no favicon, no robots.txt
no CNAME file to point to docs.automotivelinux.org
settings may differ (settings->options->github pages ->custom domain as explained here: https://help.github.com/articles/adding-or-removing-a-custom-domain-for-your-github-pages-site/ (but I don't have any rights to see the settings on docs-agl side and compare)
I can't go much further on this topic as I don't have enough rights to check the DNS zone or the detailed settings in docs-agl
The base URL needs to be
https://automotive-grade-linux.github.io/docs-gh-pages/
(e.g. https://automotive-grade-linux.github.io/docs-gh-pages/master/
Currently the links point to
https://automotive-grade-linux.github.io/master
which fails.
Some documentation has been produced and pushed to master branch after flounder branching. Those files must be backported to flounder branch and adjusted to fit flounder features.
The list of fixes:
ERROR: https://git.automotivelinux.org/apps/agl-service-audio-4a/plain/docs/4a-framework/README.md?h=flounder: got 404 errCount=49 ERROR: https://git.automotivelinux.org/apps/agl-service-audio-4a/plain/docs/4a-framework/components.md?h=flounder: got 404 errCount=40 ERROR: https://git.automotivelinux.org/apps/agl-service-audio-4a/plain/docs/4a-framework/concepts.md?h=flounder: got 404 errCount=47 ERROR: https://git.automotivelinux.org/apps/agl-service-audio-4a/plain/docs/4a-framework/images/4a-architecture.svg?h=flounder: got 404 errCount=46 ERROR: https://git.automotivelinux.org/apps/agl-service-audio-4a/plain/docs/4a-framework/images/agl-audio-arch.png?h=flounder: got 404 errCount=48 ERROR: https://git.automotivelinux.org/apps/agl-service-audio-4a/plain/docs/4a-framework/images/apps-architecture.svg?h=flounder: got 404 errCount=42 ERROR: https://git.automotivelinux.org/apps/agl-service-audio-4a/plain/docs/high-level-api/README.md?h=flounder: got 404 errCount=55 ERROR: https://git.automotivelinux.org/apps/agl-service-audio-4a/plain/docs/high-level-api/TipsAndTricks/4aTools.md?h=flounder: got 404 errCount=27 ERROR: https://git.automotivelinux.org/apps/agl-service-audio-4a/plain/docs/high-level-api/TipsAndTricks/AdjustVolumes.md?h=flounder: got 404 errCount=26 ERROR: https://git.automotivelinux.org/apps/agl-service-audio-4a/plain/docs/high-level-api/TipsAndTricks/Devices.md?h=flounder: got 404 errCount=51 ERROR: https://git.automotivelinux.org/apps/agl-service-audio-4a/plain/docs/high-level-api/TipsAndTricks/HALs.md?h=flounder: got 404 errCount=53 ERROR: https://git.automotivelinux.org/apps/agl-service-audio-4a/plain/docs/high-level-api/TipsAndTricks/images/MixerBaseMenu.png?h=flounder: got 404 errCount=15 ERROR: https://git.automotivelinux.org/apps/agl-service-audio-4a/plain/docs/high-level-api/TipsAndTricks/images/changeSound.png?h=flounder: got 404 errCount=45 ERROR: https://git.automotivelinux.org/apps/agl-service-audio-4a/plain/docs/high-level-api/kickstart.md?h=flounder: got 404 errCount=58 ERROR: https://git.automotivelinux.org/apps/agl-service-audio-4a/plain/docs/high-level-api/reference.md?h=flounder: got 404 errCount=56ERROR: https://git.automotivelinux.org/apps/agl-service-homescreen/plain/doc/parts/showInformation.svg?h=flounder: got 404 errCount=52 ERROR: https://git.automotivelinux.org/apps/agl-service-homescreen/plain/doc/parts/showNotification.svg?h=flounder: got 404 errCount=35 ERROR: https://git.automotivelinux.org/apps/agl-service-homescreen/plain/doc/parts/showOnScreen.svg?h=flounder: got 404 errCount=50 ERROR: https://git.automotivelinux.org/apps/agl-service-homescreen/plain/doc/parts/showWindow.svg?h=flounder: got 404 errCount=16ERROR: https://git.automotivelinux.org/apps/agl-service-windowmanager/plain/doc/parts/deactivate_window.png?h=flounder: got 404 errCount=29 ERROR: https://git.automotivelinux.org/apps/agl-service-windowmanager/plain/doc/parts/example_split.png?h=flounder: got 404 errCount=34 ERROR: https://git.automotivelinux.org/apps/agl-service-windowmanager/plain/doc/parts/hmi_framework_designed_seq_toyota.png?h=flounder: got 404 errCount=14 ERROR: https://git.automotivelinux.org/apps/agl-service-windowmanager/plain/doc/parts/request_role.png?h=flounder: got 404 errCount=39 ERROR: https://git.automotivelinux.org/apps/agl-service-windowmanager/plain/doc/parts/state_change_example.png?h=flounder: got 404 errCount=43 ERROR: https://git.automotivelinux.org/apps/agl-service-windowmanager/plain/doc/parts/wm_area.png?h=flounder: got 404 errCount=37 ERROR: https://git.automotivelinux.org/apps/agl-service-windowmanager/plain/doc/parts/wm_layer_stack.png?h=flounder: got 404 errCount=57 ERROR: https://git.automotivelinux.org/apps/agl-service-windowmanager/plain/doc/parts/wm_software_stack.png?h=flounder: got 404 errCount=28ERROR: https://git.automotivelinux.org/apps/app-afb-test/plain/docs/1_Write_the_tests.md?h=flounder: got 404 errCount=0 ERROR: https://git.automotivelinux.org/apps/app-afb-test/plain/docs/2_The_test_widget.md?h=flounder: got 404 errCount=5 ERROR: https://git.automotivelinux.org/apps/app-afb-test/plain/docs/3_Launch_the_tests.md?h=flounder: got 404 errCount=9 ERROR: https://git.automotivelinux.org/apps/app-afb-test/plain/docs/4_Tests_Examples.md?h=flounder: got 404 errCount=8 ERROR: https://git.automotivelinux.org/apps/app-afb-test/plain/docs/Reference/0_BindingTestFunctions.md?h=flounder: got 404 errCount=2 ERROR: https://git.automotivelinux.org/apps/app-afb-test/plain/docs/Reference/1_BindingAssertFunctions.md?h=flounder: got 404 errCount=3 ERROR: https://git.automotivelinux.org/apps/app-afb-test/plain/docs/Reference/2_TestFrameworkFunctions.md?h=flounder: got 404 errCount=10 ERROR: https://git.automotivelinux.org/apps/app-afb-test/plain/docs/Reference/LuaUnitAssertionFunctions/0_GeneralAssertions.md?h=flounder: got 404 errCount=7 ERROR: https://git.automotivelinux.org/apps/app-afb-test/plain/docs/Reference/LuaUnitAssertionFunctions/1_ValueAssertions.md?h=flounder: got 404 errCount=6 ERROR: https://git.automotivelinux.org/apps/app-afb-test/plain/docs/Reference/LuaUnitAssertionFunctions/2_ScientificAssertions.md?h=flounder: got 404 errCount=11 ERROR: https://git.automotivelinux.org/apps/app-afb-test/plain/docs/Reference/LuaUnitAssertionFunctions/3_StringAssertions.md?h=flounder: got 404 errCount=12 ERROR: https://git.automotivelinux.org/apps/app-afb-test/plain/docs/Reference/LuaUnitAssertionFunctions/4_ErrorAssertions.md?h=flounder: got 404 errCount=1 ERROR: https://git.automotivelinux.org/apps/app-afb-test/plain/docs/Reference/LuaUnitAssertionFunctions/5_TypeAssertions.md?h=flounder: got 404 errCount=13 ERROR: https://git.automotivelinux.org/apps/app-afb-test/plain/docs/Reference/LuaUnitAssertionFunctions/6_TableAssertions.md?h=flounder: got 404 errCount=4ERROR: https://git.automotivelinux.org/src/cmake-apps-module/plain/docs/dev_guide/0_Abstract.md?h=flounder: got 404 errCount=22 ERROR: https://git.automotivelinux.org/src/cmake-apps-module/plain/docs/dev_guide/1_Quickstart.md?h=flounder: got 404 errCount=62 ERROR: https://git.automotivelinux.org/src/cmake-apps-module/plain/docs/dev_guide/2_project_architecture.md?h=flounder: got 404 errCount=21 ERROR: https://git.automotivelinux.org/src/cmake-apps-module/plain/docs/dev_guide/3_advanced_usage.md?h=flounder: got 404 errCount=60 ERROR: https://git.automotivelinux.org/src/cmake-apps-module/plain/docs/dev_guide/4_advanced_customization.md?h=flounder: got 404 errCount=44 ERROR: https://git.automotivelinux.org/src/cmake-apps-module/plain/docs/dev_guide/5_autobuild.md?h=flounder: got 404 errCount=38ERROR: https://git.automotivelinux.org/src/xds/xds-docs/plain/docs/part-1/1-1_install-xds-server-docker.md?h=flounder: got 404 errCount=20 ERROR: https://git.automotivelinux.org/src/xds/xds-docs/plain/docs/part-1/1-2_install-xds-server-vm.md?h=flounder: got 404 errCount=25 ERROR: https://git.automotivelinux.org/src/xds/xds-docs/plain/docs/part-1/1-3_install-xds-server-native.md?h=flounder: got 404 errCount=24 ERROR: https://git.automotivelinux.org/src/xds/xds-docs/plain/docs/part-1/1_install-xds-server.md?h=flounder: got 404 errCount=41 ERROR: https://git.automotivelinux.org/src/xds/xds-docs/plain/docs/part-1/2_install-client.md?h=flounder: got 404 errCount=36 ERROR: https://git.automotivelinux.org/src/xds/xds-docs/plain/docs/part-2/1_xds-server/1_build.md?h=flounder: got 404 errCount=59 ERROR: https://git.automotivelinux.org/src/xds/xds-docs/plain/docs/part-2/1_xds-server/2_config.md?h=flounder: got 404 errCount=33 ERROR: https://git.automotivelinux.org/src/xds/xds-docs/plain/docs/part-2/1_xds-server/3_how-to-run.md?h=flounder: got 404 errCount=54 ERROR: https://git.automotivelinux.org/src/xds/xds-docs/plain/docs/part-2/2_xds-agent/1_build.md?h=flounder: got 404 errCount=30 ERROR: https://git.automotivelinux.org/src/xds/xds-docs/plain/docs/part-2/2_xds-agent/2_config.md?h=flounder: got 404 errCount=23 ERROR: https://git.automotivelinux.org/src/xds/xds-docs/plain/docs/part-2/2_xds-agent/3_start.md?h=flounder: got 404 errCount=19 ERROR: https://git.automotivelinux.org/src/xds/xds-docs/plain/docs/part-2/3_xds-cli/1_build.md?h=flounder: got 404 errCount=32 ERROR: https://git.automotivelinux.org/src/xds/xds-docs/plain/docs/part-2/3_xds-cli/2_config.md?h=flounder: got 404 errCount=18 ERROR: https://git.automotivelinux.org/src/xds/xds-docs/plain/docs/part-2/3_xds-cli/3_commands.md?h=flounder: got 404 errCount=31 ERROR: https://git.automotivelinux.org/src/xds/xds-docs/plain/docs/part-2/4_xds-gdb/1_build.md?h=flounder: got 404 errCount=17 ERROR: https://git.automotivelinux.org/src/xds/xds-docs/plain/docs/part-2/4_xds-gdb/2_config.md?h=flounder: got 404 errCount=61