summaryrefslogtreecommitdiffstats
path: root/docs/handle-docs/abstract.md
diff options
context:
space:
mode:
authorClément Bénier <clement.benier@iot.bzh>2019-04-16 18:40:29 +0200
committerClément Bénier <clement.benier@iot.bzh>2019-04-16 18:42:37 +0200
commit68de85c25c1d90598c5d2a2f070de25fe048c16b (patch)
treef6e77861c17325954af474e417e4c9c84382db27 /docs/handle-docs/abstract.md
parent6fd3e9232e76a8654292a868496bb052df092403 (diff)
handle-docs: add "how to handle documentation"
Change-Id: I309c44bc2199b330264e061367d57a4de41d4fbb Signed-off-by: Clément Bénier <clement.benier@iot.bzh>
Diffstat (limited to 'docs/handle-docs/abstract.md')
-rw-r--r--docs/handle-docs/abstract.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/handle-docs/abstract.md b/docs/handle-docs/abstract.md
new file mode 100644
index 0000000..5734b2f
--- /dev/null
+++ b/docs/handle-docs/abstract.md
@@ -0,0 +1,23 @@
+# Abstract
+
+AGL doc website is based on a collection of markdown files fetched from various repositories.
+A tool available in [docs-tools](https://github.com/automotive-grade-linux/docs-tools) takes
+care of collecting and templating all markdown files according fetched_files.yml located in
+[docs-webtemplate](https://github.com/automotive-grade-linux/docs-webtemplate).
+
+See below a scheme of the workflow of agl documentation website generation.
+
+![alt text](pictures/workflow.png)
+
+As you can see, the section_``version``.yml contains the links to all the book yaml files, it is proceed to fetch all book yaml files from remote repositories to the docs-webtemplate. The book yaml files contains all the url to your markdown files from the remote repository.
+
+As soon as all the markdown files are fetched, the tools process to generate the AGL doc website.
+
+---
+
+**Note:**
+
+The images described in markdown files are automatically fetched. For that, the necessary condition is that in markdown files, the relative path has to match with the location of images.
+
+---
+