Documentation build process should not fetch repositories

Description

The current build process in docs-webtemplate fetches various GitHub repositories as part of the `make fetch` step. This prevents an offline build and makes it difficult to test local changes to the documentation.

For the rest of AGL we already solve this issue using `repo`. I recommend migrating the docs to use `repo` or something similar to pull all the source repositories down in a controlled way so that the docs can be built offline easily and it becomes more straightforward to see where to make changes to the documentation and how to test them.

Environment

None

Activity

Show:

Vinod Ahuja 
April 18, 2023 at 2:41 PM

No longer applicable. 

Paul Barker 
April 18, 2023 at 8:33 AM

Some of the context for this is given by https://lf-automotivelinux.atlassian.net/browse/SPEC-3190. At that time there were "docs-sources", "docs-webtemplate" and "docs-tools" repositories under the AGL GitHub organization and there was a Makefile based build system for the docs. This appears to have been replaced with an mkdocs based system which doesn't have the same issue with offline builds. I think this issue can be closed.

Vinod Ahuja 
March 29, 2023 at 8:32 PM

can you point to the exact page link to review and make desired changes.

 

In the current documentation on section "Adding Documentation" https://docs.automotivelinux.org/en/master/#07_How_To_Contribute/08_Adding_Documentation/ I don't see any such thing. If this pertains to old documentation than we can close this issue.

Fixed

Details

Assignee

Reporter

Components

Priority

Created February 19, 2020 at 9:32 AM
Updated May 10, 2023 at 2:47 PM
Resolved April 18, 2023 at 2:41 PM