docs-sources repository needs a readme

Description

The main source repository for the documentation (https://github.com/automotive-grade-linux/docs-sources) currently lacks any sort of readme file. I had to go exploring to find the readme in docs-webtemplate and then read the Makefile and some of the javascript in docs-tools to understand how to build the docs for a local test.

The readme should cover:

  • How to build the docs locally after making changes in a checkout of docs-source.

  • How to contribute (since GitHub pull requests are used instead of Gerrit)

  • Links to mailing list, maintainers, etc

Environment

None

Activity

Show:

Walt Miner 
April 14, 2023 at 6:59 PM

This github is no longer used for docs

Sebastien Douheret 
April 8, 2020 at 6:53 AM

Did you read "How To" section (top nav bar) of doc web site  ?
 https://docs.automotivelinux.org/docs/en/master/howto/reference/handle-docs/abstract.html
 https://docs.automotivelinux.org/docs/en/master/howto/reference/handle-docs/documentation-usage.html#documentation-from-local-repositories

But maybe you already read it and you think it's not sufficient, so feel free to complete it...

Won't Fix

Details

Assignee

Reporter

Components

Priority

Created February 19, 2020 at 9:29 AM
Updated April 14, 2023 at 6:59 PM
Resolved April 14, 2023 at 6:59 PM