diff options
19 files changed, 93 insertions, 195 deletions
diff --git a/conf/_config.yml b/conf/_config.yml index 04fa6a4..86db312 100644 --- a/conf/_config.yml +++ b/conf/_config.yml @@ -5,8 +5,9 @@ # ======= # Site settings # ======= -title: "AGL WebDocs" -title_suffix: "Contributed initially by IoT.bzh" +title_prefix: "AGL Documentation - " +title: " " +title_suffix: " -" url: "http://docs.automotivelinux.org" # the base hostname & protocol description: AGL (Automotive Grade Linux) Developer Website diff --git a/site/_includes/head.html b/site/_includes/head.html index 8f1523f..87596c7 100644 --- a/site/_includes/head.html +++ b/site/_includes/head.html @@ -7,6 +7,7 @@ <meta name="description" content="{% if page.excerpt %}{{ page.excerpt | strip_html | strip_newlines | truncate: 160 }}{% else if page.description %}{{ page.description }} {% else %}{{ site.description }}{% endif %}"> <title> + {{ site.title_prefix }} {% if page.title %} {% if page.title_suffix %} {{ page.title }} {{ page.title_suffix }} diff --git a/site/_includes/header.html b/site/_includes/header.html index 7199b9b..b26533b 100644 --- a/site/_includes/header.html +++ b/site/_includes/header.html @@ -15,7 +15,7 @@ <div class="nav_bar_center"> <ul class="nav navbar-nav"> <li {% if page.specs_tab %}class="active"{% endif %}> - <a href="{{ site.docsurl }}/quickstart/en/{{ site.default_linked_docs_version }}/">Getting Started</a> + <a href="{{ site.docsurl }}/getting_started/en/{{ site.default_linked_docs_version }}/">Getting Started</a> </li> <li {% if page.appfw_tab %}class="active"{% endif %}> @@ -27,7 +27,7 @@ </li> <li {% if page.appfw_tab %}class="active"{% endif %}> - <a href="{{ site.docsurl }}/bindings/en/{{ site.default_linked_docs_version }}/">APIs & Services</a> + <a href="{{ site.docsurl }}/apis_services/en/{{ site.default_linked_docs_version }}/">APIs & Services</a> </li> <li {% if page.blog_tab %}class="active"{% endif %}> diff --git a/site/_layouts/bindings-en.html b/site/_layouts/apis_services-en.html index 1a8a097..1a8a097 100644 --- a/site/_layouts/bindings-en.html +++ b/site/_layouts/apis_services-en.html diff --git a/site/_layouts/quickstart-en.html b/site/_layouts/getting_started-en.html index 1a8a097..1a8a097 100644 --- a/site/_layouts/quickstart-en.html +++ b/site/_layouts/getting_started-en.html diff --git a/site/_tocs/quickstart/fetched_files.yml b/site/_tocs/apis_services/fetched_files.yml index 8f2095a..86318a4 100644 --- a/site/_tocs/quickstart/fetched_files.yml +++ b/site/_tocs/apis_services/fetched_files.yml @@ -15,18 +15,5 @@ # title: "optional: info about document (default label, overloaded by file content)" # -url_fetch : "GITHUB_FETCH" -url_edit : "GITHUB_EDIT" -git_commit : "master" -#dst_prefix : # destination_path = destination_prefix + (document.destination || document.source) - -repositories: -- - git_name : "iotbzh/agl-porter" - documents : - - source: "guide/booting-agl-sdk.md" -- - git_name : "iotbzh/agl-qmu" - documents : - - source: "guide/booting-agl-sdk.md" - +url_fetch : "GERRIT_FETCH" +repositories: diff --git a/site/_tocs/apis_services/toc_dev_en.yml b/site/_tocs/apis_services/toc_dev_en.yml new file mode 100644 index 0000000..5511f41 --- /dev/null +++ b/site/_tocs/apis_services/toc_dev_en.yml @@ -0,0 +1,9 @@ +# WARNING: +# - TOC should reference .HTML and .md (Index OK but Error 404) +# - do not forget to run 'docbuild --tocs' after any changes + +name: APIs & Services +template: generated_index.html +children: + + diff --git a/site/_tocs/architecture/fetched_files.yml b/site/_tocs/architecture/fetched_files.yml index 2638640..4f18585 100644 --- a/site/_tocs/architecture/fetched_files.yml +++ b/site/_tocs/architecture/fetched_files.yml @@ -15,47 +15,9 @@ # title: "optional: info about document (default label, overloaded by file content)" # -url_fetch : "GERRIT_FETCH" +url_fetch : "GITHUB_FETCH" commit : "master" #git_commit : # default defined in _tocs/xxxx/latest.yml #dst_prefix : # destination_path = destination_prefix + (document.destination || document.source) repositories: -- - git_name : "src/app-framework-main.git" - dst_prefix : "ap/main" - src_prefix : "docs" - documents : - - source: "overview.md" - label: "afm overview" - - source: "afm-system-daemon.md" - - source: "afm-user-daemon.md" - -- - git_name : "src/app-framework-binder.git" - src_prefix : "doc" - dst_prefix : "ap/binder" - documents : - - source: "afb-overview.md" - - source: "afb-application-writing.md" - - source: "afb-bindings-overview.md" - - source: "afb-bindings-writing.md" - - label: "afb basic test" - source: "afb-tests-overview.md" - - label: "afb vocabulary" - source: "afb-daemon-vocabulary.md" -#- -# git_name : "docs/security-blueprint" -# dst_prefix : "security/blueprint" -# documents : -# - source: "overview.md" -# - source: "risks.md" -# - source: "attack-surface.md" -# -#- -# git_name : "docs/aglcore-specifications" -# dst_prefix : "specifications/aglcore" -# documents : -# - source: "overview.md" -# - source: "risks.md" -# - source: "attack-surface.md" diff --git a/site/_tocs/architecture/toc_dev_en.yml b/site/_tocs/architecture/toc_dev_en.yml index 0649a73..ada3ecc 100644 --- a/site/_tocs/architecture/toc_dev_en.yml +++ b/site/_tocs/architecture/toc_dev_en.yml @@ -2,22 +2,7 @@ # - TOC should reference .HTML and .md (Index OK but Error 404) # - do not forget to run 'docbuild --tocs' after any changes -name: Architecture +name: Architecture Guides template: generated_index.html children: -- - name: Introduction to AGL project - children: - - url: reference/ap/main/overview.html - - url: reference/ap/binder/afb-overview.html - - url: reference/ap/binder/afb-bindings-overview.html -- - name: Booting AGL on your target - children: - - url: reference/ap/main/afm-system-daemon.html - - url: reference/ap/main/afm-user-daemon.html - - url: reference/ap/binder/afb-application-writing.html - - url: reference/ap/binder/afb-bindings-writing.html - - diff --git a/site/_tocs/bindings/fetched_files.yml b/site/_tocs/bindings/fetched_files.yml deleted file mode 100644 index e6d6d9f..0000000 --- a/site/_tocs/bindings/fetched_files.yml +++ /dev/null @@ -1,42 +0,0 @@ -# REFERENCE ENTRY: -# - -# url_fetch : gitweb fetch URL (format string with token %repo% %uri% -# GERRIT_FETCH= "https://gerrit.automotivelinux.org/gerrit/gitweb?p=%repo%;a=blob_plain;f=%source%;hb=%commit%" -# GITHUB_FETCH= "https://raw.githubusercontent.com/%repo%/%commit%/%source%" -# repository: git repository name -# GITHUB_EDIT= "https://raw.github.com/%repo%/blob/%commit%/%source%" -# git_commit: git commit when not default -# destination_prefix: optional destination prefix -# documents: -# - -# source : "source patch within url_fetch" -# destination : "optional: destination path default=path.join(destination_prefix+source)" -# label: "optional: friendly name for submenu default=basename(source) overloaded by file content" -# title: "optional: info about document (default label, overloaded by file content)" -# - -url_fetch : "GERRIT_FETCH" -repositories: -- - git_name : "src/app-framework-main.git" - dst_prefix : "ap/main" - src_prefix : "docs" - documents : - - source: "overview.md" - label: "afm overview" - - source: "afm-system-daemon.md" - - source: "afm-user-daemon.md" - -- - git_name : "src/app-framework-binder.git" - src_prefix : "doc" - dst_prefix : "ap/binder" - documents : - - source: "afb-overview.md" - - source: "afb-application-writing.md" - - source: "afb-bindings-overview.md" - - source: "afb-bindings-writing.md" - - source: "afb-tests-overview.md" - label : "afb basic test" - - source: "afb-daemon-vocabulary.md" - label : "afb vocabulary" diff --git a/site/_tocs/bindings/toc_dev_en.yml b/site/_tocs/bindings/toc_dev_en.yml deleted file mode 100644 index 1b4c7c0..0000000 --- a/site/_tocs/bindings/toc_dev_en.yml +++ /dev/null @@ -1,20 +0,0 @@ -# WARNING: -# - TOC should reference .HTML and .md (Index OK but Error 404) -# - do not forget to run 'docbuild --tocs' after any changes - -name: Bindings -template: generated_index.html -children: -- - name: Introduction - children: - - url: guide/overview/index.html -- - name: Application Framework - children: - - url: reference/ap/main/afm-system-daemon.html - - url: reference/ap/main/afm-user-daemon.html - - url: reference/ap/binder/afb-application-writing.html - - url: reference/ap/binder/afb-bindings-writing.html - - diff --git a/site/_tocs/getting_started/fetched_files.yml b/site/_tocs/getting_started/fetched_files.yml new file mode 100644 index 0000000..3dc750c --- /dev/null +++ b/site/_tocs/getting_started/fetched_files.yml @@ -0,0 +1,44 @@ +# REFERENCE ENTRY: +# - +# url_fetch : gitweb fetch URL (format string with token %repo% %uri% +# GERRIT_FETCH= "https://gerrit.automotivelinux.org/gerrit/gitweb?p=%repo%;a=blob_plain;f=%source%;hb=%commit%" +# GITHUB_FETCH= "https://raw.githubusercontent.com/%repo%/%commit%/%source%" +# repository: git repository name +# GITHUB_EDIT= "https://raw.github.com/%repo%/blob/%commit%/%source%" +# git_commit: git commit when not default +# destination_prefix: optional destination prefix +# documents: +# - +# source : "source patch within url_fetch" +# destination : "optional: destination path default=path.join(destination_prefix+source)" +# label: "optional: friendly name for submenu default=basename(source) overloaded by file content" +# title: "optional: info about document (default label, overloaded by file content)" +# + +url_fetch : "GITHUB_FETCH" +url_edit : "GITHUB_EDIT" +git_commit : "master" +#dst_prefix : # destination_path = destination_prefix + (document.destination || document.source) + +repositories: +- + git_name : automotive-grade-linux/docs-agl + src_prefix : docs/getting-started + documents : + - source: source-code.md + label: Download AGL Source Code + - source: machines/qemu.md + label: Build for Qemu + - source: machines/porter.md + label: Build for Renesas Porter board + - source: machines/raspberrypi.md + label: Build for Raspberry PI 2/3 + - source: troubleshooting.md + label: Troubleshooting + - source: footers/porter-footer.md + label: Porter board + - source: footers/raspberrypi-footer.md + label: Rasperry PI + - source: images/RaspberryPi2-ModelB-debug-serial-cable.jpg + destination: footers/images/RaspberryPi2-ModelB-debug-serial-cable.jpg + diff --git a/site/_tocs/getting_started/toc_dev_en.yml b/site/_tocs/getting_started/toc_dev_en.yml new file mode 100644 index 0000000..44bcfe8 --- /dev/null +++ b/site/_tocs/getting_started/toc_dev_en.yml @@ -0,0 +1,21 @@ +# WARNING: +# - TOC should reference .HTML and .md (Index OK but Error 404) +# - do not forget to run 'docbuild --tocs' after any changes + +name: Getting started +template: generated_index.html +children: +- + name: Getting Started + children: + - url: reference/source-code.html + - url: reference/machines/qemu.html + - url: reference/machines/porter.html + - url: reference/machines/raspberrypi.html +- + name: Known Issues + children: + - url: reference/troubleshooting.html + - url: reference/footers/porter-footer.html + - url: reference/footers/raspberrypi-footer.html + diff --git a/site/_tocs/hardware/fetched_files.yml b/site/_tocs/hardware/fetched_files.yml index 1d77012..1e0c4c7 100644 --- a/site/_tocs/hardware/fetched_files.yml +++ b/site/_tocs/hardware/fetched_files.yml @@ -21,25 +21,4 @@ git_commit : "master" #dst_prefix : # destination_path = destination_prefix + (document.destination || document.source) repositories: - -- - git_name : "apache/cordova-cli" - documents : - - - label: "cordova" - source: "doc/readme.md" - destination: "cordova-cli/index.md" -- - git_name: "apache/cordova-plugin-battery-status" - documents: - - - source: "README.md" - destination: "cordova-plugin-battery-status/index.md" - -- - git_name: "apache/cordova-plugin-camera" - documents: - - - source: "README.md" - destination: "cordova-plugin-camera/index.md" diff --git a/site/_tocs/hardware/toc_dev_en.yml b/site/_tocs/hardware/toc_dev_en.yml index e7c604e..ba0c41a 100644 --- a/site/_tocs/hardware/toc_dev_en.yml +++ b/site/_tocs/hardware/toc_dev_en.yml @@ -2,18 +2,8 @@ # - TOC should reference .HTML and .md (Index OK but Error 404) # - do not forget to run 'docbuild --tocs' after any changes -name: Hardware +name: Hardware Support template: generated_index.html children: -- - name: Introduction - children: - - url: guide/overview/index.html -- - name: Create application - children: - - url: reference/cordova-cli/index.html - - url: reference/cordova-plugin-battery-status/index.html - - url: reference/cordova-plugin-camera/index.html diff --git a/site/_tocs/quickstart/toc_dev_en.yml b/site/_tocs/quickstart/toc_dev_en.yml deleted file mode 100644 index fdc2990..0000000 --- a/site/_tocs/quickstart/toc_dev_en.yml +++ /dev/null @@ -1,19 +0,0 @@ -# WARNING: -# - TOC should reference .HTML and .md (Index OK but Error 404) -# - do not forget to run 'docbuild --tocs' after any changes - -name: Quickstart -template: generated_index.html -children: -- - name: Introduction - children: - - url: guide/overview/index.html -- - name: Create application - children: - - url: reference/cordova-cli/index.html - - url: reference/cordova-plugin-battery-status/index.html - - url: reference/cordova-plugin-camera/index.html - - diff --git a/site/docs/docsearch.html b/site/docs/docsearch.html index 4e1888f..678464a 100644 --- a/site/docs/docsearch.html +++ b/site/docs/docsearch.html @@ -6,10 +6,10 @@ {% include head.html %} <body> - <h3><a href="{{ site.docsurl }}/architecture/en/{{ site.default_linked_docs_version }}/">Achitecture Guideline</a></h3> - <h3><a href="{{ site.docsurl }}/bindings/en/{{ site.default_linked_docs_version }}/">Services & API</a></h3> - <h3><a href="{{ site.docsurl }}/hardware/en/{{ site.default_linked_docs_version }}/">Supported Hardware</a></h3> - <h3><a href="{{ site.docsurl }}/quickstart/en/{{ site.default_linked_docs_version }}/">Quick Start</a></h3> + <h3><a href="{{ site.docsurl }}/architecture/en/{{ site.default_linked_docs_version }}/">Architecture Guides</a></h3> + <h3><a href="{{ site.docsurl }}/apis_services/en/{{ site.default_linked_docs_version }}/">APIs & Services</a></h3> + <h3><a href="{{ site.docsurl }}/hardware/en/{{ site.default_linked_docs_version }}/">Hardware Support</a></h3> + <h3><a href="{{ site.docsurl }}/getting_started/en/{{ site.default_linked_docs_version }}/">Getting started</a></h3> {% include algolia.html %} </body> diff --git a/site/index.html b/site/index.html index ab1384a..58f68c4 100644 --- a/site/index.html +++ b/site/index.html @@ -19,7 +19,7 @@ change_frequency: monthly <p>Multiple platforms on <em>a common code base</em></p> <p>Free and <em>open source</em></p> <div class="hero_buttons"> - <a href="{{ site.baseurl }}/quickstart/en/{{ site.default_linked_docs_version }}" class="col-xs-12 col-sm-5 btn btn-lg btn-primary"> + <a href="{{ site.baseurl }}/getting_started/en/{{ site.default_linked_docs_version }}" class="col-xs-12 col-sm-5 btn btn-lg btn-primary"> Get Started </a> </div> diff --git a/site/static/styles/scss/webdocs.scss b/site/static/styles/scss/webdocs.scss index 79edc17..edea001 100644 --- a/site/static/styles/scss/webdocs.scss +++ b/site/static/styles/scss/webdocs.scss @@ -222,9 +222,9 @@ code { border-radius: 4px !important; } -H1 { - display: none; -} +//H1 { +// display: none; +//} .error { color: red; |