Merge pull request #41 from bci-oss/documentation-update

Documentation update

Author: atextor

AUTHORS.md

@@ -2,10 +2,10 @@
 
 The following people have contributed to this repository:
 
-* [Hanna Shalamitskaya](mailto:[email protected])
-* [Andreas Textor](mailto:[email protected])
-* [Georg Schmidt-Dumont](mailto:[email protected])
-* [Michele Santoro](mailto:[email protected])
+* [Hanna Shalamitskaya](https://github.com/Hanna-Shalamitskaya-EPAM), [email protected]
+* [Andreas Textor](https://github.com/atextor), Robert Bosch GmbH, [email protected]
+* Georg Schmidt-Dumont, Robert Bosch GmbH, [email protected]
+* [Michele Santoro](https://github.com/michelu89), Robert Bosch GmbH, [email protected]
 * Nico Makowe
 * Aghyad Farrouh
 

CONTRIBUTING.md

@@ -4,8 +4,40 @@ The following document contains a compilation of conventions and guidelines to f
 structure and write code for the ESMF SDK PY Aspect Model Loader.
 
 ## General Conventions
-Our code conventions are based on the [Google Python Style Guide](https://google.github.io/styleguide/pyguide.html) but
-detailed and adjusted for the needs of the ESMF SDK py Aspect Model Loader.
+
+Our code conventions are based on the [Google Python Style Guide](https://google.github.io/styleguide/pyguide.html), 
+but detailed and adjusted for the needs of the ESMF SDK PY Aspect Model Loader.
 
 ## Copyright header
 See [CONTRIBUTING](CONTRIBUTING.md)
+
+## Code Recommendations
+
+The code for this project follows the guidelines of [PEP 8](https://peps.python.org/pep-0008/).
+The libraries black, flake8 and isort are also used so that the code can be checked for compliance with the PEP 8 style.
+
+## Documentation
+
+### Developer Documentation
+Developer documentation is put into a README.md placed in the project root. This should contain documentation like:
+* Checking out the source code and getting it to run/build
+* Mandatory (external system) dependencies and how to set them up (e.g. databases)
+* Configuration options and how to apply them
+* General important concepts that are relevant to working on the project but are not directly obvious from the source code
+  itself. Links to further readings and information, e.g. wiki or other external sources.
+
+### User documentation
+
+User documentation (this includes technical documentation on how to use an application or tool from the 
+ESMF SDK PY Aspect Model Loader Code Conventions) should be on its own.
+
+It is written in AsciiDoc, rendered with [Antora](https://antora.org) and the generated static content is
+publicly hosted for direct user access.
+The source files of the documentation are placed in a subfolder /documentation from the project root.
+Documentation is structured so that it can be processed by Antora. This e.g. involves structuring the documentation files
+according to [Antora's specification](https://docs.antora.org/antora/2.3/organize-content-files/) and organizing resources
+so that Antora [can handle them](https://docs.antora.org/antora/2.3/page/resource-id/).
+[AsciiDoc's syntax](https://docs.antora.org/antora/2.3/asciidoc/asciidoc/) is pretty close to Markdown, however it is
+way more targeted towards writing fully fledged documents and with its multitude of backends (HTML, PDF, ...) it is a
+very good source format.
+Publishing is realized by means of [GitHub pages](https://docs.antora.org/antora/2.3/publish-to-github-pages/).

CONVENTIONS.md

@@ -370,4 +370,4 @@ Exhibit B - "Incompatible With Secondary Licenses" Notice
 ---------------------------------------------------------
 
   This Source Code Form is "Incompatible With Secondary Licenses", as
-  defined by the Mozilla Public License, v. 2.0.
+  defined by the Mozilla Public License, v. 2.0.

LICENSE

@@ -1 +1,7 @@
+## Antora
 
+This repository contains software developed by the [Antora Project](https://antora.org/).
+
+Your use of Antora is subject to the terms and conditions of the Mozilla Public License 2.0. A copy of the license is contained in the file [LICENSE.txt](/LICENSE.txt) and is also available at https://mozilla.org/MPL/2.0/.
+
+The source code is available from [GitLab](https://gitlab.com/antora).

NOTICE.md

@@ -22,28 +22,26 @@
 ## Introduction
 
 The ESMF SDK Python Aspect Model Loader contains artifacts and resources for all parties that intent to use, extend or
-integrate with the Semantic Aspect Meta Model, e.g., Solution Developers,
-Domain Experts or OEMs.
+integrate with the Semantic Aspect Meta Model, e.g., Solution Developers, Domain Experts or OEMs.
 
 At its core are components which help to work with the Semantic Aspect Meta Model (SAMM).
 
-This repository contains a detailed developer documentation written in AsciiDoc. The source files (AsciiDoc) are
-located [here](documentation/python-sdk-guide)
-and are built using
-[Antora](https://antora.org/) which generates the documentation as HTML files.
+This repository contains a detailed developer documentation written in AsciiDoc. The source files (AsciiDoc) are 
+[python-sdk-guide](documentation/python-sdk-guide) and are built using [Antora](https://antora.org/) 
+which generates the documentation as HTML files.
 
 ## Getting help
 
-Are you having trouble with ESMF SDK Python? We want to help!
+Are you having trouble with ESMF SDK Python Aspect Model Loader? We want to help!
 
 * Check the [developer documentation](https://eclipse-esmf.github.io)
-* Having issues with the ESMF SDK Python? Open
-  a [GitHub issue](https://github.com/eclipse-esmf/esmf-sdk-py-aspect-model-loader/issues).
+* Check the SAMM [specification](https://eclipse-esmf.github.io/samm-specification/snapshot/index.html)
+* Having issues with the ESMF SDK Python Aspect Model Loader? Open a [GitHub issue](https://github.com/eclipse-esmf/esmf-sdk-py-aspect-model-loader/issues).
 
 ## Getting Started
 
 This document provides an overall overview of the SDK and the concepts applied throughout it. Detailed documentation and
-concepts for each component can be found in the respective subfolders or subrepositories.
+concepts for each component can be found in the respective subfolders or sub-repositories.
 
 ## SDK Structure
 
@@ -55,7 +53,6 @@ esmf-sdk-py-aspect-model-loader
  ├─── core                                      # e.g. meta model implementation etc.
  │     ├─── esmf-aspect-meta-model-python
  │     ├─── ...
- └─── samples                                   # sample projects to get you started quickly
 ```
 
 ## Python Core Components
@@ -73,7 +70,8 @@ generated source code artifacts. Any form of source code generator will use the
 
 ## Version Handling
 
-The aspect meta model loader work with the SAMM versions specified in the [download_samm_release.py](core/esmf-aspect-meta-model-python/esmf_aspect_meta_model_python//samm_aspect_meta_model/download_samm_release.py). This version will be used for deployment.
+The aspect meta model loader work with the SAMM versions specified in the [download_samm_release.py](core/esmf-aspect-meta-model-python/esmf_aspect_meta_model_python//samm_aspect_meta_model/download_samm_release.py). 
+This version will be used for deployment.
 
 As SAMM evolves over time, the Aspect Meta Model Loader should also adapt and evolve accordingly.
 Due to this fact it is important to understand the versioning concept that is applied to the SAMM,

README.md

@@ -34,9 +34,6 @@ Required
 - [Install poetry](#install-poetry)
 - [Install project dependencies](#install-project-dependencies)
 - [Download SAMM files](#download-samm-files)
-Optional
-- [Download SAMM CLI](#download-samm-cli) (needed  to use SAMM CLI functions)
-- [Download SAMM test models](#download-test-models) (for running integration tests)
 
 ### Install poetry