New "overview.md" based on "index.md" - and new image

OpenTOSCA · Jul 13, 2018 · db784cf · db784cf
1 parent 0a1a0d4
commit db784cf
Show file tree

Hide file tree

Showing 7 changed files with 81 additions and 20 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -1 +1,9 @@
 * text=auto eol=lf
+
+*.java eol=lf
+*.md eol=lf
+
+*.docx -text
+*.pptx -text
+*.png -text
+*.jpg -text
diff --git a/docs/adr/0027-use-dasherization-for-filenames.md b/docs/adr/0027-use-dasherization-for-filenames.md
@@ -0,0 +1,36 @@
+# Use dasherization for filenames
+
+## Context and Problem Statement
+
+Graphics files have to take a consistent file name
+
+## Decision Drivers <!-- optional -->
+
+* Easy to process by Jekyll
+* No WTFs at the creators
+
+## Considered Options
+
+* [Dasherization](https://softwareengineering.stackexchange.com/a/104476/52607) (e.g., `architecture-bpmn4tosca.png`)
+* Camel Case (e.g., `ArchitectureBPMN4TOSCA.png`)
+
+## Decision Outcome
+
+Chosen option: "Dasherization", because
+
+* clear separation of parts of the name
+* consistent to other URLs (which are typically lowercase)
+
+## License
+
+Copyright (c) 2018 Contributors to the Eclipse Foundation
+
+See the NOTICE file(s) distributed with this work for additional
+information regarding copyright ownership.
+
+This program and the accompanying materials are made available under the
+terms of the Eclipse Public License 2.0 which is available at
+http://www.eclipse.org/legal/epl-2.0, or the Apache Software License 2.0
+which is available at https://www.apache.org/licenses/LICENSE-2.0.
+
+SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
diff --git a/docs/adr/index.md b/docs/adr/index.md
@@ -30,7 +30,8 @@ This lists the architectural decisions for Eclipse Winery.
 - [ADR-0023](0023-use-maven-as-build-tool.md) - Use Maven as build tool
 - [ADR-0024](0024-use-travis-for-continuous-integration.md) - Use TravisCI for Continuous Integration
 - [ADR-0025](0025-use-same-logback-test-xml-for-each-sub-project.md) - Use same `logback-test.xml` for each sub project
-- [ADR-0026](0026-store-license-and-readme-in-entity-root-folder-in-csar.md) - Store `LICENSE` and `README.md` in respective entity's root folder in a CSAR 
+- [ADR-0026](0026-store-license-and-readme-in-entity-root-folder-in-csar.md) - Store `LICENSE` and `README.md` in respective entity's root folder in a CSAR
+- [ADR-0027](0027-use-dasherization-for-filenames.md) - Use dasherization for filenames
 
 <!-- adrlogstop -->
 

diff --git a/docs/user/graphics/WineryComponents.png b/docs/user/graphics/WineryComponents.png
diff --git a/docs/user/graphics/pptx/components.pptx b/docs/user/graphics/pptx/components.pptx
diff --git a/docs/user/index.md b/docs/user/index.md
@@ -5,24 +5,7 @@ It is an Eclipse project and thus support is available through its project page
 Winery is also part of the OpenTOSCA ecosystem where more information is available at <http://www.opentosca.org>.
 For more information on TOSCA see [our TOSCA information page](../tosca/).
 
-![Winery Components](graphics/WineryComponents.png)
-
-Winery consists of four parts (1) the type and template management, (2) the topology modeler, (3) the BPMN4TOSCA plan modeler, and (4) the repository.
-
-The type, template and artifact management enables managing all TOSCA types, templates and related artifacts.
-This includes node types, relationship types, policy types, artifact types, artifact templates, and artifacts such as virtual machine images.
-
-The topology modeler enables to create service templates.
-Service templates consists of instances of node types (node templates) and instances of relationship types (relationship templates).
-They can be annotated with requirements and capabilities, properties, and policies.
-
-The BPMN4TOSCA plan modeler offers web based creation of BPMN models with the TOSCA extension BPMN4TOSCA.
-That means the modeler supports the BPMN elements and structures required by TOSCA plans and not the full set of BPMN [KBBL12].
-This part is currently in development and not part of the opensourced code of Winery.
-
-The repository stores TOSCA models and allows managing their content. For instance, node types, policy types, and artifact templates are managed by the repository.
-The repository is also responsible for importing and  exporting CSARs, the exchange format of TOSCA files and related artifacts.
-
+- [overview](overview.md) - overview on Winery
 - [FAQ](FAQ.md) - frequently asked questions
 - [Quickstart](quickstart.md)
 - [Modeling Guide](modeling-guide.md) - Guide how to use Winery
@@ -48,7 +31,7 @@ More readings at <https://www.opentosca.org>.
 
 ## License
 
-Copyright (c) 2017 Contributors to the Eclipse Foundation
+Copyright (c) 2017-2018 Contributors to the Eclipse Foundation
 
 See the NOTICE file(s) distributed with this work for additional
 information regarding copyright ownership.

diff --git a/docs/user/overview.md b/docs/user/overview.md
@@ -0,0 +1,33 @@
+# Overview
+
+![Winery Components](graphics/components.png)
+
+Winery consists of four parts (1) the type and template management, (2) the topology modeler, (3) the BPMN4TOSCA plan modeler, and (4) the repository.
+
+The type, template and artifact management enables managing all TOSCA types, templates and related artifacts.
+This includes node types, relationship types, policy types, artifact types, artifact templates, and artifacts such as virtual machine images.
+
+The topology modeler enables to create service templates.
+Service templates consists of instances of node types (node templates) and instances of relationship types (relationship templates).
+They can be annotated with requirements and capabilities, properties, and policies.
+
+The BPMN4TOSCA plan modeler offers web based creation of BPMN models with the TOSCA extension BPMN4TOSCA.
+That means the modeler supports the BPMN elements and structures required by TOSCA plans and not the full set of BPMN [KBBL12].
+This part is currently in development and not part of the opensourced code of Winery.
+
+The repository stores TOSCA models and allows managing their content. For instance, node types, policy types, and artifact templates are managed by the repository.
+The repository is also responsible for importing and  exporting CSARs, the exchange format of TOSCA files and related artifacts.
+
+## License
+
+Copyright (c) 2017-2018 Contributors to the Eclipse Foundation
+
+See the NOTICE file(s) distributed with this work for additional
+information regarding copyright ownership.
+
+This program and the accompanying materials are made available under the
+terms of the Eclipse Public License 2.0 which is available at
+http://www.eclipse.org/legal/epl-2.0, or the Apache Software License 2.0
+which is available at https://www.apache.org/licenses/LICENSE-2.0.
+
+SPDX-License-Identifier: EPL-2.0 OR Apache-2.0