aboutsummaryrefslogtreecommitdiffstats
path: root/docs/5_How_To/1_Abstract.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/5_How_To/1_Abstract.md')
-rw-r--r--docs/5_How_To/1_Abstract.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/docs/5_How_To/1_Abstract.md b/docs/5_How_To/1_Abstract.md
new file mode 100644
index 0000000..63561fb
--- /dev/null
+++ b/docs/5_How_To/1_Abstract.md
@@ -0,0 +1,32 @@
+---
+edit_link: ''
+title: Abstract
+origin_url: >-
+ https://raw.githubusercontent.com/automotive-grade-linux/docs-sources/master/docs/handle-docs/abstract.md
+---
+
+<!-- WARNING: This file is generated by fetch_docs.js using /home/boron/Documents/AGL/docs-webtemplate/site/_data/tocs/howto/master/howto-add-docs-handle-docs-book.yml -->
+
+# 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.
+
+---
+