diff options
author | Merlin Carter <merlin.carter@here.com> | 2019-08-21 15:00:29 +0200 |
---|---|---|
committer | Merlin Carter <merlin.carter@here.com> | 2019-08-28 15:49:52 +0200 |
commit | 8ee9e9c0607d7ce0c057f2cb7454973ddf7a5778 (patch) | |
tree | 2865323929588b36965e666d4978cf59af6e5a79 /docs/modules/ROOT/nav.adoc | |
parent | abfc287de407fe53cbbdd6edb9d08cf8cf51b298 (diff) | |
download | meta-updater-8ee9e9c0607d7ce0c057f2cb7454973ddf7a5778.tar.gz |
OTA-3594: adding restructured Antora-friendly content
-Adding Antora dir structure
- Break up content into individual file
- Setting up files for including in other repos
- Making options easier to read and more consistent with other
reference doc.
- Updated README to link to individual topic files rather than
all on one page.
- Added Mathias's requested HW and bootloader info
- Added xaviers requested NRE clause.
Signed-off-by: Merlin Carter <merlin.carter@here.com>
Diffstat (limited to 'docs/modules/ROOT/nav.adoc')
-rw-r--r-- | docs/modules/ROOT/nav.adoc | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc new file mode 100644 index 0000000..d4b577b --- /dev/null +++ b/docs/modules/ROOT/nav.adoc | |||
@@ -0,0 +1,17 @@ | |||
1 | // MC: NOTE ABOUT TOC | ||
2 | // Adding "pageroot" attr so that TOC that will also work directly in GitHub. Because... | ||
3 | // In Antora the "pages" subdir is implcit added to the xref path at build time. | ||
4 | // if you add "/pages" Antora will intepret it as "pages/pages". | ||
5 | // The pages subdir is NOT implicit when viewing source files in Github. | ||
6 | |||
7 | ifdef::env-github[:pageroot: pages/] | ||
8 | ifndef::env-github[:pageroot:] | ||
9 | |||
10 | .Guide to the Build Tools | ||
11 | * xref:{pageroot}metaupdater-whatis.adoc[What are the build tools?] | ||
12 | * xref:{pageroot}build.adoc[Build a disk image] | ||
13 | * xref:{pageroot}supported-boards.adoc[Supported Boards] | ||
14 | * xref:{pageroot}meta-updater-usage.adoc[How to] | ||
15 | * xref:{pageroot}sota-variables.adoc[Configuration reference] | ||
16 | * xref:{pageroot}dev-config.adoc[Development configuration] | ||
17 | * xref:{pageroot}meta-updater-testing.adoc[Testing] \ No newline at end of file | ||