.gitlab-ci.yml

@@ -28,18 +28,26 @@ doxygen:
   before_script:
     - apk update && apk --no-cache add git doxygen graphviz ttf-freefont texmf-dist texmf-dist-latexextra texlive texlive-dvi
   script:
-    # libaries
-    - git clone --recurse-submodules https://gitlab-ci-token:${CI_JOB_TOKEN}@git.rwth-aachen.de/unicado/libraries
-    - cd libraries/aircraftGeometry2/doc/ && ( cat Doxyfile ; echo "OUTPUT_DIRECTORY = $CI_PROJECT_DIR/docs/documentation/" ) | doxygen -
+    # clone repos
+    - git clone https://gitlab-ci-token:${CI_JOB_TOKEN}@git.rwth-aachen.de/unicado/aircraft-design
+    - cd aircraft-design
+    - git clone --recurse-submodules https://gitlab-ci-token:${CI_JOB_TOKEN}@git.rwth-aachen.de/unicado/libraries libs/
+    # create aircraft design documentation
+    - cd propulsion_design/doc/ && ( cat Doxyfile ; echo "OUTPUT_DIRECTORY = $CI_PROJECT_DIR/docs/documentation/" ) | doxygen -
+    - cd ../../wing_design/doc/ && ( cat Doxyfile ; echo "OUTPUT_DIRECTORY = $CI_PROJECT_DIR/docs/documentation/" ) | doxygen -
+    - cd ../../empennage_design/doc/ && ( cat Doxyfile ; echo "OUTPUT_DIRECTORY = $CI_PROJECT_DIR/docs/documentation/" ) | doxygen -
+    - cd ../../ecological_assessment/doc/ && ( cat Doxyfile ; echo "OUTPUT_DIRECTORY = $CI_PROJECT_DIR/docs/documentation/" ) | doxygen -
+    - cd ../../cost_estimation/doc/ && ( cat Doxyfile ; echo "OUTPUT_DIRECTORY = $CI_PROJECT_DIR/docs/documentation/" ) | doxygen -
+    - cd ../../fuselage_design/doc/ && ( cat Doxyfile ; echo "OUTPUT_DIRECTORY = $CI_PROJECT_DIR/docs/documentation/" ) | doxygen -
+    - cd ../../initial_sizing/doc/ && ( cat Doxyfile ; echo "OUTPUT_DIRECTORY = $CI_PROJECT_DIR/docs/documentation/" ) | doxygen -
+    - cd ../../landing_gear_design/doc/ && ( cat Doxyfile ; echo "OUTPUT_DIRECTORY = $CI_PROJECT_DIR/docs/documentation/" ) | doxygen -
+    - cd ../../systems_design/doc/ && ( cat Doxyfile ; echo "OUTPUT_DIRECTORY = $CI_PROJECT_DIR/docs/documentation/" ) | doxygen -
+    - cd ../../tank_design/doc/ && ( cat Doxyfile ; echo "OUTPUT_DIRECTORY = $CI_PROJECT_DIR/docs/documentation/" ) | doxygen -
+    # create libraries documentation
+    - cd ../../libs/aircraftGeometry2/doc/ && ( cat Doxyfile ; echo "OUTPUT_DIRECTORY = $CI_PROJECT_DIR/docs/documentation/" ) | doxygen -
     - cd ../../engine/doc/ && ( cat Doxyfile ; echo "OUTPUT_DIRECTORY = $CI_PROJECT_DIR/docs/documentation/" ) | doxygen -
     - cd $CI_PROJECT_DIR
-    # aircraft design
-    - git clone --recurse-submodules https://gitlab-ci-token:${CI_JOB_TOKEN}@git.rwth-aachen.de/unicado/aircraft-design
-    - cd aircraft-design/propulsion_design/doc/ && ( cat Doxyfile ; echo "OUTPUT_DIRECTORY = $CI_PROJECT_DIR/docs/documentation/" ) | doxygen -
-    - cd ../../aircraft-design/wing_design/doc/ && ( cat Doxyfile ; echo "OUTPUT_DIRECTORY = $CI_PROJECT_DIR/docs/documentation/" ) | doxygen -
-    - cd ../../aircraft-design/empennage_design/doc/ && ( cat Doxyfile ; echo "OUTPUT_DIRECTORY = $CI_PROJECT_DIR/docs/documentation/" ) | doxygen -
-    - cd ../../aircraft-design/ecological_assessment/doc/ && ( cat Doxyfile ; echo "OUTPUT_DIRECTORY = $CI_PROJECT_DIR/docs/documentation/" ) | doxygen -
-        
+
   artifacts:
     paths:
       - $CI_PROJECT_DIR/docs/documentation
@@ -61,21 +69,6 @@ pages:
     - pip install pipenv
     - pipenv install
   script:
-    - mkdir $CI_PROJECT_DIR/docs/aircraft-xml
-    - python $CI_PROJECT_DIR/scripts/document_aircraft_xml.py --title General --level 1 $CI_PROJECT_DIR/scripts/CSR-02.xml > $CI_PROJECT_DIR/docs/aircraft-xml/general.md
-    - python $CI_PROJECT_DIR/scripts/document_aircraft_xml.py --title MassesAndLoadings --level 3 $CI_PROJECT_DIR/scripts/CSR-02.xml > $CI_PROJECT_DIR/docs/aircraft-xml/masses.md
-    - python $CI_PROJECT_DIR/scripts/document_aircraft_xml.py --title Geometry --level 6 $CI_PROJECT_DIR/scripts/CSR-02.xml > $CI_PROJECT_DIR/docs/aircraft-xml/geometry.md
-    - python $CI_PROJECT_DIR/scripts/document_aircraft_xml.py --title Structure --level 2 $CI_PROJECT_DIR/scripts/CSR-02.xml > $CI_PROJECT_DIR/docs/aircraft-xml/structure.md
-    - python $CI_PROJECT_DIR/scripts/document_aircraft_xml.py --title Accommodation --level 2 $CI_PROJECT_DIR/scripts/CSR-02.xml > $CI_PROJECT_DIR/docs/aircraft-xml/accommodation.md
-    - python $CI_PROJECT_DIR/scripts/document_aircraft_xml.py --title Propulsion --level 3 $CI_PROJECT_DIR/scripts/CSR-02.xml > $CI_PROJECT_DIR/docs/aircraft-xml/propulsion.md
-    - python $CI_PROJECT_DIR/scripts/document_aircraft_xml.py --title Systems --level 2 $CI_PROJECT_DIR/scripts/CSR-02.xml > $CI_PROJECT_DIR/docs/aircraft-xml/systems.md
-    - python $CI_PROJECT_DIR/scripts/document_aircraft_xml.py --title Aerodynamics --level 2 $CI_PROJECT_DIR/scripts/CSR-02.xml > $CI_PROJECT_DIR/docs/aircraft-xml/aerodynamics.md
-    - python $CI_PROJECT_DIR/scripts/document_aircraft_xml.py --title StabilityAndControlCharacteristics --level 2 $CI_PROJECT_DIR/scripts/CSR-02.xml > $CI_PROJECT_DIR/docs/aircraft-xml/stability.md
-    - python $CI_PROJECT_DIR/scripts/document_aircraft_xml.py --title Performance --level 4 $CI_PROJECT_DIR/scripts/CSR-02.xml > $CI_PROJECT_DIR/docs/aircraft-xml/performance.md
-    - python $CI_PROJECT_DIR/scripts/document_aircraft_xml.py --title MonetaryValues --level 4 $CI_PROJECT_DIR/scripts/CSR-02.xml > $CI_PROJECT_DIR/docs/aircraft-xml/monetary.md
-    - python $CI_PROJECT_DIR/scripts/document_aircraft_xml.py --title EcologicalValues --level 4 $CI_PROJECT_DIR/scripts/CSR-02.xml > $CI_PROJECT_DIR/docs/aircraft-xml/ecological.md
-    - python $CI_PROJECT_DIR/scripts/document_aircraft_xml.py --title Requirements --level 3 $CI_PROJECT_DIR/scripts/CSR-02.xml > $CI_PROJECT_DIR/docs/aircraft-xml/requirements.md
-    - python $CI_PROJECT_DIR/scripts/document_aircraft_xml.py --title DesignSpecification --level 4 $CI_PROJECT_DIR/scripts/CSR-02.xml > $CI_PROJECT_DIR/docs/aircraft-xml/specification.md
     - pipenv run mkdocs build --site-dir $CI_PROJECT_DIR/public
   needs:
     - doxygen

.gitlab/issue_templates/Default.md

-## Summary
+<!-- Title: Provide a concise and descriptive title for the issue incl. tool or library name -->
 
-**Please choose an appropriate template to categorize your issue.**
+## Choose Your Issue Template
+Before creating an issue, please review existing issues to avoid duplicates!
+ALso, select the **appropriate type for your issue in the desciption drop-down**. 
+- Bug Report Template
+- Feature Request Template
+- TODO Template
+- Documentation Request Template
+- Testing Request Template
 
-(Summarize the issue concisely)
+If not suitable, use the sections below and contact the owners.
 
-- **Unicado Version**: vx.x.x
-- **Page**: page-name
+## Description
+Provide a concise description of the issue.
 
-## Additional information
-
-(Paste any relevant information to further describe the issue)
-
-/label ~"needs information"
+## Additional Context
+Add screenshots, logs, or relevant information here.

.gitlab/issue_templates/Todo.md

-## Summary
-
-(Summarize the todo concisely)
-
-- **Page**: page-name
-
-## Steps to do
-
-- [ ] Add the steps you need to do.
-
-/label ~"type::todo"
-

.gitlab/issue_templates/bug_report.md

+<!-- Title: Provide a concise and descriptive title for the issue incl. tool or library name -->
+# Bug Report
+
+## Description
+Describe the bug clearly. What happened?
+
+## Steps to Reproduce
+1. [Step 1]
+2. [Step 2]
+3. [Step 3]
+
+## Expected Behavior
+Explain what you expected to see.
+
+## Environment
+- **OS**: [e.g., Windows 10]
+- **Version/Branch**: [e.g., v1.2.3]
+
+## Additional Context
+Attach any logs, screenshots, or context.
+
+/label ~"type::bug"

.gitlab/issue_templates/Documentation.md → .gitlab/issue_templates/documentation_request.md

-## Summary
+<!-- Title: Provide a concise and descriptive title for the issue -->
+# Documentation
 
-(Explain what documentation is missing.)
+## Summary
+Explain what documentation is missing.
 
 - **Unicado Version**: vx.x.x 
 - **Page**: page-to-change
 
-## Further details
-
-(Give further details why and how the documentation can be improved
-if applicable.)
+## Additional Context
+Attach any logs, screenshots, or context.
 
 /label ~"type::documentation"
 

.gitlab/issue_templates/feature_request.md

+<!-- Title: Provide a concise and descriptive title for the issue incl. tool or library name -->
+# Feature Request
+
+## Summary
+What feature are you requesting?
+
+## Why?
+Explain the problem this feature solves or the value it adds.
+
+## Acceptance Criteria
+- [ ] Define measurable outcomes for success.
+- [ ] List specific requirements.
+
+## Additional Notes
+Include references, examples, or diagrams if applicable.
+
+/label ~"type::feature"

.gitlab/issue_templates/testing_request.md

+<!-- Title: Provide a concise and descriptive title for the issue incl. tool or library name -->
+# Testing Issue
+
+## Summary
+Provide a brief overview of what should be tested or changed in the test process. Also think about what is the goal of this test? E.g.
+- Verify that [feature/bug fix/module] works as expected.
+- Ensure that [specific requirement] is met.
+
+## Related Issues or Merge Requests
+- Issue(s): #[Issue ID]
+- Merge Request(s): #[Merge Request ID]
+
+## Expected Results
+- [Outcome 1]: [What should happen].
+- [Outcome 2]: [Another expected result].
+
+## Environment
+- **OS**: [e.g., Windows 10]
+- **Version/Branch**: [e.g., v1.2.3]
+
+## Additional Context
+Attach any logs, screenshots, or context.
+
+/label ~"type::testing"

.gitlab/issue_templates/todo.md

+<!-- Title: Provide a concise and descriptive title for the issue incl. tool or library name -->
+# TODO
+
+## Summary
+Briefly describe the task. Provide any background information or related issues.
+
+## Subtasks
+- [ ] Step 1
+- [ ] Step 2
+- [ ] Step 3
+
+## Acceptance Criteria
+- [ ] Define measurable outcomes for success.
+- [ ] List specific requirements.
+
+/label ~"type::todo"

.gitlab/merge_request_templates/Default.md

-## What does this MR do and why?
+<!-- Title: Use an imperative, clear title (e.g., "Fix login bug" or "Add new analytics feature") -->
 
-- **Page**: page-name
+## Description
+Provide a concise explanation of the changes made in this merge request.
 
-(Describe in detail what your merge request does and why.
+## Related Issue(s)
+- Closes #[feature issues]
+- Fixes #[bug report issue] 
+- Resolves #[any other issues]
 
-Please keep this description updated with any discussion that takes place so
-that reviewers can understand your intent. Keeping the description updated is
-especially important if they didn't participate in the discussion.)
+### Other Changes
+- [Mention refactoring, tests, etc.]
 
-%{first_multiline_commit}
+## Screenshots/Logs
+Attach screenshots or log outputs if applicable.
 
-## How to set up and validate locally
+## Testing Instructions
+1. [Step 1: How to test]
+2. [Step 2: Expected outcome]
+3. [Step 3: Additional steps if required]
 
-(Please provide instructions if your MR needs special commands or packages
-to work which are not part of the standard Unicado Package.)
+## Developer Checklist
+- [ ] Code has been tested locally and/or in pipeline.
+- [ ] (if applicable) documentation updated.
+- [ ] (if applicable) impact of new dependencies reviewed and included in project.
+- [ ] Merge conflicts resolved with the target branch.
+
+## Additional Notes
+Add any information reviewers should focus on, e.g., specific files, functions, or changes of interest.

CODEOWNERS

+# Repository-specific code ownership
+  *                           @unicado-consortium/tum   @unicado-consortium/tuhh    @unicado-consortium/tub-fmra
+
+# File-specific code ownership
+.gitattributes                @Florian.Schueltke
+.gitignore                    @Florian.Schueltke
+.gitlab-ci.yml                @maurice.zimmnau   @kristina.mazur
+CMakeLists.txt                @Florian.Schueltke
+CMakePresets.json             @Florian.Schueltke
+CODEOWNERS                    @Florian.Schueltke
+LICENSE                       @Florian.Schueltke
+README.md                     @Florian.Schueltke

README.md

@@ -46,27 +46,3 @@ date: yyyy-mm-dd
 
 <Content goes here>
 ```
-
-# Tools
-The documentation page uses some custom tools to enable a seamless continuous documentation:
-
-## document_aircraft_xml.py
-> Script
-
-This script is used to document the aircraft exchange file.
-It parses the XML file and creates the documentation for each node using its description.
-
-The usage is explained in the output when calling the script with the `--help` option:
-```sh
-usage: document_aircraft_xml.py [-h] [--title title] [--level level] filename
-
-Converts an aircraft XML file to a markdown file. The output is streamed to stdout and can be piped to a file.
-
-positional arguments:
-  filename       The XML file to convert.
-
-options:
-  -h, --help     show this help message and exit
-  --title title  The title of the output page. This also sets the root node which is used to create the document.
-  --level level  The maximum level nodes to be used as headers.
-```