From 48986d26efaf81af64318eeba06d8d01b4ea1367 Mon Sep 17 00:00:00 2001 From: Sebastien Douheret Date: Wed, 6 Dec 2017 18:22:42 +0100 Subject: Added missing xds-cli in toc Signed-off-by: Sebastien Douheret --- content/tocs/devguides/toc_dev_en.yml | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/content/tocs/devguides/toc_dev_en.yml b/content/tocs/devguides/toc_dev_en.yml index e63af6d..00dcc39 100644 --- a/content/tocs/devguides/toc_dev_en.yml +++ b/content/tocs/devguides/toc_dev_en.yml @@ -124,11 +124,14 @@ children: name: xds-agent url: reference/xds/part-2/2_xds-agent.html - - name: xds-exec - url: reference/xds/part-2/3_xds-exec.html + name: xds-cli + url: reference/xds/part-2/3_xds-cli.html - name: xds-gdb url: reference/xds/part-2/4_xds-gdb.html + - + name: xds-exec + url: reference/xds/part-2/5_xds-exec.html - name: Guides children: -- cgit From d756f0604a581cc161e16e5b92856619690abf70 Mon Sep 17 00:00:00 2001 From: mudcam Date: Thu, 7 Dec 2017 10:31:22 +0100 Subject: Add proposal for new security blueprint --- content/tocs/apis_services/fetched_files.yml | 9 +-- content/tocs/architecture/fetched_files.yml | 88 +++++++++++++++++++++++++++- content/tocs/architecture/toc_dev_en.yml | 70 ++++++++++++++++++++-- 3 files changed, 153 insertions(+), 14 deletions(-) diff --git a/content/tocs/apis_services/fetched_files.yml b/content/tocs/apis_services/fetched_files.yml index b0cd424..da0758b 100644 --- a/content/tocs/apis_services/fetched_files.yml +++ b/content/tocs/apis_services/fetched_files.yml @@ -23,7 +23,7 @@ # ------------------------------------ # url: "GERRIT_FETCH" # git_commit: "master" -# repositories: +# repositories: # - # git_name: src/foo # src_prefix: docs @@ -40,7 +40,7 @@ url_fetch : "GERRIT_FETCH" git_commit : "AGL_GERRIT_BRANCH" -repositories: +repositories: - git_name : src/app-framework-main git_commit: master @@ -153,9 +153,6 @@ repositories: - source: architecture.md destination: architecture.md label: Signaling Architecture - - source: high-level-viwi-service.md - destination: high-level-viwi-service.md - label: High level ViWi service Guide - source: index.md destination: resources.md label: Resources @@ -166,7 +163,6 @@ repositories: - source: images/distributed-arch.svg - source: images/distributed-arch.png - source: images/signal-service-arch.svg - - source: images/high-level-arch.png - url_fetch: http://iot.bzh/download/public/2016/%source% dst_prefix: iotbzh2016 @@ -267,4 +263,3 @@ repositories: destination: pictures/api_requestSurfaceIdToFullScreen.png - source: pictures/api_surfaceVisibilityChanged.png destination: pictures/api_surfaceVisibilityChanged.png - diff --git a/content/tocs/architecture/fetched_files.yml b/content/tocs/architecture/fetched_files.yml index 4dcddff..080c9cb 100644 --- a/content/tocs/architecture/fetched_files.yml +++ b/content/tocs/architecture/fetched_files.yml @@ -23,7 +23,7 @@ # ------------------------------------ # url: "GERRIT_FETCH" # git_commit: "master" -# repositories: +# repositories: # - # git_name: src/foo # src_prefix: docs @@ -43,7 +43,7 @@ git_commit : "AGL_GITHUB_BRANCH" #git_commit : # default defined in _tocs/xxxx/latest.yml #dst_prefix : # destination_path = destination_prefix + (document.destination || document.source) -repositories: +repositories: - url_fetch: https://wiki.automotivelinux.org/_media/%source% dst_prefix: AGL_Specifications @@ -68,3 +68,87 @@ repositories: label: Application Security - source: 07-system-hardening.md label: System Hardening + +- + git_name : "%project_source%/docs-agl" + src_prefix : docs/security-blueprint + dst_prefix: security + documents: + - source: README.md + label: Introduction + - source: WhiteBoxArchi.png + label: AGL architecture + - source: annexes/0_Abstract.md + label: Annexes + - source: annexes/ConfigNotes.md + label: Config notes + - source: annexes/todo.md + label: todo + - source: annexes/todoNotes.md + label: Todo notes + - source: part-1/0_Abstract.md + label: Introduction + - source: part-2/0_Abstract.md + label: Introduction + - source: part-2/1-Image.md + label: Image + - source: part-2/2-Communication-modes.md + label: Communication modes + - source: part-2/3-Consoles.md + label: Consoles + - source: part-3/0_Abstract.md + label: Introduction + - source: part-4/0_Abstract.md + label: Introduction + - source: part-4/1-General.md + label: General + - source: part-4/2-Memory.md + label: Memory + - source: part-4/3-Consoles.md + label: Consoles + - source: part-4/4-Debug.md + label: Debug + - source: part-4/5-FileSystems.md + label: File Systems + - source: part-5/0_Abstract.md + label: Introduction + - source: part-5/1-MAC.md + label: Mandatory Access Control + - source: part-5/2-SystemD.md + label: SystemD + - source: part-5/3-SystemBus.md + label: SystemBus + - source: part-5/4-Services.md + label: System services and daemons + - source: part-5/5-AppFw.md + label: App Framework + - source: part-5/6-Utilities.md + label: Utilities + - source: part-5/7-Users.md + label: Users + - source: part-6/0_Abstract.md + label: Introduction + - source: part-6/1-Installation.md + label: Installation + - source: part-6/2-PrivilegeManagement.md + label: Privilege management + - source: part-6/3-Signature.md + label: Signature + - source: part-6/4-Services.md + label: Services + - source: part-7/0_Abstract.md + label: Introduction + - source: part-7/1-BusAndConnectors.md + label: Bus and connectors + - source: part-7/2-Wireless.md + label: Wireless + - source: part-7/3-Cloud.md + label: Cloud + - source: part-8/0_Abstract.md + label: Introduction + - source: part-8/1-FOTA.md + label: FOTA + - source: part-8/2-SOTA.md + label: SOTA + - source: part-9/0_Abstract.md + label: Introduction diff --git a/content/tocs/architecture/toc_dev_en.yml b/content/tocs/architecture/toc_dev_en.yml index 06b73dc..f857775 100644 --- a/content/tocs/architecture/toc_dev_en.yml +++ b/content/tocs/architecture/toc_dev_en.yml @@ -1,9 +1,9 @@ ####################################################################### -# WARNING: +# WARNING: # - TOC should reference .HTML and .md (Index OK but Error 404) -# - do not forget to run 'docbuild --tocs' after any changes +# - do not forget to run 'docbuild --tocs' after any changes +# # -# ############################ SYNTAX ################################### # GLOBAL OPTIONS: # name: TOC (page) title @@ -13,7 +13,7 @@ # TOC Entry: # name: TOC entry (level 1) # children: -# - +# - # name: optional name for TOC entry (default: use URL FrontMatter info) # url: Date: Fri, 8 Dec 2017 17:40:04 +0100 Subject: Added templating for section-xxx tags. Security Blueprint doc uses specific tags to display arrays (see docs/security-blueprint/README.md) Signed-off-by: Sebastien Douheret --- site/static/js/docs.js | 13 ++++++ site/static/styles/scss/_sections.scss | 83 ++++++++++++++++++++++++++++++++++ site/static/styles/scss/webdocs.scss | 1 + 3 files changed, 97 insertions(+) create mode 100644 site/static/styles/scss/_sections.scss diff --git a/site/static/js/docs.js b/site/static/js/docs.js index 1309525..9247cd3 100644 --- a/site/static/js/docs.js +++ b/site/static/js/docs.js @@ -139,4 +139,17 @@ $(document).ready(function () { element.innerText = ''; } }); + + $('#page-toc-source').each(function(index, element) { + // Process section-xxx (eg. section-note or section-config) in order + // to apply right style (see webdocs-agl/site/static/styles/scss/_sections.scss ) + ['section-note', 'section-config', 'section-warning', 'section-todo'].forEach(function (sec) { + try { + res = element.innerHTML.replace(new RegExp('', 'g'), ''); + element.innerHTML = res.replace(new RegExp('', 'g'), '
'); + } catch(err) { } + }); + }); + + }); diff --git a/site/static/styles/scss/_sections.scss b/site/static/styles/scss/_sections.scss new file mode 100644 index 0000000..889e12a --- /dev/null +++ b/site/static/styles/scss/_sections.scss @@ -0,0 +1,83 @@ + +/* section-note blocks */ + +div.section-note { + background: #FCF8E3 none repeat scroll 0% 0%; + color: #4e4e4e; + padding: 15px; + margin-bottom: 10px; + border-bottom: 5px solid #DDD; + border-color: #FAEBCC; + page-break-inside: avoid; +} +div.section-note table { + background: white; +} + +div.section-note p { + padding-bottom: 0; + margin-bottom: 0; +} + +/* section-warning blocks */ + +div.section-warning { + background: #FD9595 none repeat scroll 0% 0%; + color: #4e4e4e; + padding: 15px; + margin-bottom: 10px; + border-bottom: 5px solid #DDD; + border-color: #FF6B6B; + page-break-inside: avoid; +} + +div.section-warning table { + background: white; +} + +div.section-warning p { + padding-bottom: 0; + margin-bottom: 0; +} + +/* section-config blocks */ + +div.section-config { + background: #d2e2ee none repeat scroll 0% 0%; + color: #4e4e4e; + padding: 15px; + margin-bottom: 10px; + border-bottom: 5px solid #DDD; + border-color: #b5c5d1; + page-break-inside: avoid; +} + +div.section-config table { + background: white; +} + +div.section-config p { + padding-bottom: 0; + margin-bottom: 0; +} + +/* section-todo blocks */ + +div.section-todo { + background: #d3eed2 none repeat scroll 0% 0%; + color: #4e4e4e; + padding: 15px; + margin-bottom: 10px; + border-bottom: 5px solid #DDD; + border-color: #b1d5b0; + page-break-inside: avoid; +} + +div.section-todo table { + background: white; +} + +div.section-todo p { + padding-bottom: 0; + margin-bottom: 0; +} diff --git a/site/static/styles/scss/webdocs.scss b/site/static/styles/scss/webdocs.scss index ccd8572..ae3b6b0 100644 --- a/site/static/styles/scss/webdocs.scss +++ b/site/static/styles/scss/webdocs.scss @@ -242,3 +242,4 @@ code { @import '_contribute'; @import '_contact'; @import '_artwork'; +@import '_sections'; -- cgit From 84c61bdf6399a3ddcfce86d340a40d73ec4fd32e Mon Sep 17 00:00:00 2001 From: Walt Miner Date: Fri, 8 Dec 2017 15:12:14 -0600 Subject: Fix copyright dates to include 2017 --- conf/_config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/conf/_config.yml b/conf/_config.yml index ecce84d..cb5cba3 100644 --- a/conf/_config.yml +++ b/conf/_config.yml @@ -15,7 +15,7 @@ baseurl: "" # the subpath of the site, e.g. /blog; NOTE: no trailing slas docsurl: "/docs" # docsearch entry point rss_path: /misc/feed.xml -copyright_date: "2015-2016" +copyright_date: "2015-2017" excerpt_separator: -- cgit