tags

OpenTOSCA · Jul 17, 2023 · 45cf621 · 45cf621
1 parent ad7eeff
commit 45cf621
Show file tree

Hide file tree

Showing 39 changed files with 191 additions and 3 deletions.
diff --git a/docs/cmds/interface/template.ejs b/docs/cmds/interface/template.ejs
@@ -1,3 +1,8 @@
+---
+tags:
+- Vintner
+---
+
 # Interface
 
 {{ autogenerated_notice('yarn docs:generate:interface') }}

diff --git a/docs/cmds/licenses/template.ejs b/docs/cmds/licenses/template.ejs
@@ -1,3 +1,8 @@
+---
+tags:
+- Vintner
+---
+
 # Dependencies
 
 {{ autogenerated_notice('yarn docs:generate:licenses') }}
@@ -16,7 +21,7 @@ We ensure, that only the licenses <%- "MIT;Apache-2.0;Python-2.0;BSD-2-Clause;BS
 <% }) %>
 
 There are several issues.
-We fixed some of them by patching the dependencies using [`patch-package`](https://github.com/ds300/patch-package){target=_blank}.
+We fixed some of them by patching the dependencies.
 
 1. The release of [[email protected]](https://www.npmjs.com/package/dreamopt){target=_blank} has no license.
 However, the project is according to the author licensed under MIT as stated in [#2](https://github.com/andreyvit/dreamopt.js/issues/2){target=_blank}.

diff --git a/docs/cmds/query/introduction.template.ejs b/docs/cmds/query/introduction.template.ejs
@@ -1,5 +1,8 @@
 ---
 title: Introduction
+tags:
+- Queries4TOSCA
+- Specification
 ---
 
 --8<-- "enumerate.html"

diff --git a/docs/cmds/variability/introduction.template.ejs b/docs/cmds/variability/introduction.template.ejs
@@ -1,5 +1,8 @@
 ---
 title: Introduction
+tags:
+- Variability4TOSCA
+- Specification
 ---
 
 --8<-- "enumerate.html"

diff --git a/docs/docs/about-us/index.md b/docs/docs/about-us/index.md
@@ -1,3 +1,8 @@
+---
+tags:
+- Misc
+---
+
 # About Us
 
 This project is developed for the purpose of research by the [Institute of Software Engineering (ISTE)](https://www.iste.uni-stuttgart.de){target=_blank} and the [Institute of Architecture of Application Systems (IAAS)](https://www.iaas.uni-stuttgart.de){target=_blank} of the [University of Stuttgart, Germany](https://www.uni-stuttgart.de){target=_blank}.

diff --git a/docs/docs/assets/stylesheets/extra.css b/docs/docs/assets/stylesheets/extra.css
@@ -106,4 +106,4 @@
 /* Black banner */
 .md-banner {
     background-color: black;
-}
+}
diff --git a/docs/docs/assets/stylesheets/print.css b/docs/docs/assets/stylesheets/print.css
@@ -11,4 +11,8 @@
     body {
         zoom: 70%;
     }
+
+    .md-tags {
+        display: none;
+    }
 }
diff --git a/docs/docs/assets/stylesheets/typeset.css b/docs/docs/assets/stylesheets/typeset.css
@@ -112,3 +112,9 @@ tr > td {
 .md-typeset .tabbed-labels {
     box-shadow: none;
 }
+
+/* Tag */
+.md-tag {
+    font-size: 14px !important;
+    font-weight: 400 !important;
+}
diff --git a/docs/docs/contributing/code-of-conduct.md b/docs/docs/contributing/code-of-conduct.md
@@ -1,5 +1,7 @@
 ---
 title: Code of Conduct
+tags:
+- Contributing
 ---
 
 # Contributor Covenant Code of Conduct

diff --git a/docs/docs/contributing/development.md b/docs/docs/contributing/development.md
@@ -1,3 +1,8 @@
+---
+tags:
+- Contributing
+---
+
 # Development
 
 Contributions are very much welcome.

diff --git a/docs/docs/contributing/documentation.md b/docs/docs/contributing/documentation.md
@@ -1,3 +1,8 @@
+---
+tags:
+- Contributing
+---
+
 # Documentation
 
 This document gives an introduction on writing the documentation.
@@ -24,6 +29,7 @@ yarn docs:install
 ```
 
 To start a local development server on [http://localhost:8000](http://localhost:8000){target=_blank}, run the following command.
+Note that the performance is suffering due to the used plugins.
 
 ```shell linenums="1"
 yarn docs:serve

diff --git a/docs/docs/contributing/notes.md b/docs/docs/contributing/notes.md
@@ -1,3 +1,8 @@
+---
+tags:
+- Contributing
+---
+
 # Notes
 
 This document contains a collection of arbitrary notes.

diff --git a/docs/docs/contributing/setup.md b/docs/docs/contributing/setup.md
@@ -1,3 +1,8 @@
+---
+tags:
+- Contributing
+---
+
 # Setup
 
 We use the following setup as working environment during development. 

diff --git a/docs/docs/dependencies.md b/docs/docs/dependencies.md
@@ -1,3 +1,8 @@
+---
+tags:
+- Vintner
+---
+
 # Dependencies
 
 {{ autogenerated_notice('yarn docs:generate:licenses') }}
@@ -166,7 +171,7 @@ We ensure, that only the licenses [0BSD](https://choosealicense.com/licenses/0bs
 
 
 There are several issues.
-We fixed some of them by patching the dependencies using [`patch-package`](https://github.com/ds300/patch-package){target=_blank}.
+We fixed some of them by patching the dependencies.
 
 1. The release of [[email protected]](https://www.npmjs.com/package/dreamopt){target=_blank} has no license.
 However, the project is according to the author licensed under MIT as stated in [#2](https://github.com/andreyvit/dreamopt.js/issues/2){target=_blank}.

diff --git a/docs/docs/faq.md b/docs/docs/faq.md
@@ -1,3 +1,8 @@
+---
+tags:
+- Misc
+---
+
 # FAQ 
 
 ## Is Vintner an Orchestrator? 

diff --git a/docs/docs/getting-started.md b/docs/docs/getting-started.md
@@ -1,3 +1,9 @@
+---
+tags:
+- Vintner
+- Guide
+---
+
 # Getting Started
 
 {{ asciinema_player('getting-started') }}

diff --git a/docs/docs/installation.md b/docs/docs/installation.md
@@ -1,3 +1,8 @@
+---
+tags:
+- Vintner
+---
+
 # Installation
 
 In this document, we describe ways to install `vintner`.

diff --git a/docs/docs/interface.md b/docs/docs/interface.md
@@ -1,3 +1,8 @@
+---
+tags:
+- Vintner
+---
+
 # Interface
 
 {{ autogenerated_notice('yarn docs:generate:interface') }}

diff --git a/docs/docs/orchestrators.md b/docs/docs/orchestrators.md
@@ -1,3 +1,8 @@
+---
+tags:
+- Vintner
+---
+
 # Orchestrators
 
 We currently support [xOpera](https://github.com/xlab-si/xopera-opera){target=_blank} and [Unfurl](https://github.com/onecommons/unfurl){target=_blank}.

diff --git a/docs/docs/publications.md b/docs/docs/publications.md
@@ -1,3 +1,9 @@
+---
+tags:
+- Misc
+- Publication
+---
+
 # Publications
 
 This document contains a list of selected publications.

diff --git a/docs/docs/queries4tosca/getting-started.md b/docs/docs/queries4tosca/getting-started.md
@@ -1,3 +1,9 @@
+---
+tags:
+- Queries4TOSCA
+- Guide
+---
+
 # Getting Started
 
 There is no standardized way to query TOSCA repositories or instance data. 

diff --git a/docs/docs/queries4tosca/specification.md b/docs/docs/queries4tosca/specification.md
@@ -1,5 +1,8 @@
 ---
 title: Specification
+tags:
+- Queries4TOSCA
+- Specification
 ---
 
 --8<-- "enumerate.html"

diff --git a/docs/docs/queries4tosca/tests/introduction.md b/docs/docs/queries4tosca/tests/introduction.md
@@ -1,5 +1,8 @@
 ---
 title: Introduction
+tags:
+- Queries4TOSCA
+- Specification
 ---
 
 --8<-- "enumerate.html"

diff --git a/docs/docs/resources.md b/docs/docs/resources.md
@@ -1,3 +1,8 @@
+---
+tags:
+- Misc
+---
+
 # Resources
 
 This document contains a collection of interesting resources such as the TOSCA specifications, introductions, popular orchestrators and TOSCA repositories.

diff --git a/docs/docs/sofdcar/guides/location/index.md b/docs/docs/sofdcar/guides/location/index.md
@@ -1,3 +1,9 @@
+---
+tags:
+- SofDCar
+- Guide
+---
+
 # Distributed Locations
 
 In this document, we discuss an example of two geographically distributed ECUs using the TOSCA SofDCar profile.

diff --git a/docs/docs/sofdcar/guides/zone/index.md b/docs/docs/sofdcar/guides/zone/index.md
@@ -1,3 +1,9 @@
+---
+tags:
+- SofDCar
+- Guide
+---
+
 # Zonal Architecture
 
 In this document, we discuss an example of a zonal architecture using the TOSCA SofDCar profile.

diff --git a/docs/docs/sofdcar/profile.md b/docs/docs/sofdcar/profile.md
@@ -1,5 +1,8 @@
 ---
 title: Profile
+tags:
+- SofDCar
+- Specification
 ---
 
 --8<-- "enumerate.html"

diff --git a/docs/docs/tags.md b/docs/docs/tags.md
@@ -0,0 +1,10 @@
+---
+tags:
+- Misc
+---
+
+# Tags
+
+This document contains tags used throughout this documentation.
+
+[TAGS]
diff --git a/docs/docs/variability4tosca/benchmark.md b/docs/docs/variability4tosca/benchmark.md
@@ -1,3 +1,9 @@
+--- 
+tags:
+- Variability4TOSCA
+- Specification
+---
+
 # Benchmark
 
 To benchmark our implementation of a Variability4TOSCA processor, we run several tests.

diff --git a/docs/docs/variability4tosca/dynamic.md b/docs/docs/variability4tosca/dynamic.md
@@ -1,5 +1,9 @@
 --- 
 title: Dynamic Deployment Artifacts
+tags:
+- Variability4TOSCA
+- Specification
+- Experimental
 ---
 
 --8<-- "enumerate.html"

diff --git a/docs/docs/variability4tosca/feature-ide.md b/docs/docs/variability4tosca/feature-ide.md
@@ -1,5 +1,8 @@
 --- 
 title: Feature IDE
+tags:
+- Variability4TOSCA
+- Specification
 ---
 
 --8<-- "enumerate.html"

diff --git a/docs/docs/variability4tosca/guides/artifacts/index.md b/docs/docs/variability4tosca/guides/artifacts/index.md
@@ -1,3 +1,11 @@
+---
+tags:
+- Variability4TOSCA
+- Guide
+- Publication
+- CoopIS 2023
+---
+
 # Conditional Deployment Artifacts and Conditional Properties
 
 In the following, we provide a detailed step-by-step tutorial to deploy the enterprise plan of the shopping application to showcase conditional deployment artifacts and conditional properties, as presented in Figure 1.

diff --git a/docs/docs/variability4tosca/guides/pipes-and-filters/index.md b/docs/docs/variability4tosca/guides/pipes-and-filters/index.md
@@ -1,3 +1,10 @@
+---
+tags:
+- Variability4TOSCA
+- Guide
+- Experimental
+---
+
 # Pipes and Filters Application
 
 !!! Warning

diff --git a/docs/docs/variability4tosca/guides/pruning/index.md b/docs/docs/variability4tosca/guides/pruning/index.md
@@ -1,3 +1,10 @@
+---
+tags:
+- Variability4TOSCA
+- Guide
+- Experimental
+---
+
 # Pruning Application
 
 !!! Warning

diff --git a/docs/docs/variability4tosca/motivation/index.md b/docs/docs/variability4tosca/motivation/index.md
@@ -1,3 +1,11 @@
+---
+tags:
+- Variability4TOSCA
+- Guide
+- Publication
+- Algorithms 2022
+---
+
 # Motivation
 
 In the following, we provide a detailed step-by-step tutorial to deploy the development variant of the motivating scenario, as presented in Figure 1.

diff --git a/docs/docs/variability4tosca/specification/index.md b/docs/docs/variability4tosca/specification/index.md
@@ -1,5 +1,8 @@
 ---
 title: Specification
+tags:
+- Variability4TOSCA
+- Specification
 ---
 
 --8<-- "enumerate.html"

diff --git a/docs/docs/variability4tosca/testing.md b/docs/docs/variability4tosca/testing.md
@@ -1,5 +1,8 @@
 ---
 title: Testing
+tags: 
+- Variability4TOSCA
+- Specification
 ---
 
 --8<-- "enumerate.html"

diff --git a/docs/docs/variability4tosca/tests/introduction.md b/docs/docs/variability4tosca/tests/introduction.md
@@ -1,5 +1,8 @@
 ---
 title: Introduction
+tags:
+- Variability4TOSCA
+- Specification
 ---
 
 --8<-- "enumerate.html"

diff --git a/docs/mkdocs.yaml b/docs/mkdocs.yaml
@@ -69,6 +69,8 @@ markdown_extensions:
           emoji_generator: !!python/name:materialx.emoji.to_svg
 plugins:
     - search
+    - tags:
+          tags_file: tags.md
     - macros:
           on_error_fail: true
           module_name: macros
@@ -137,3 +139,4 @@ nav:
           - publications.md
           - about-us
           - faq.md
+          - tags.md