WIP: First structure for engineering fundamentals

README.md

@@ -18,7 +18,7 @@ The developer documentation is organized into sections covering :
 - [Products](./products/)
 - [Resources](./resources/)
 
-Refer to its [structure](./index.md) to understand better. Contributions to improve the content are welcome, following the outlined [contribution guidelines](./resources/guidelines/documentation-guidelines/06-doc-process.md). The markdown content undergoes workflow checks for easier maintenance. Further details are outlined below. 
+Refer to its [structure](./index.md) to understand better. Contributions to improve the content are welcome, following the outlined [contribution guidelines](fundamentals/non-functional-req/documentation/developer-documentation/06-doc-process.md). The markdown content undergoes workflow checks for easier maintenance. Further details are outlined below. 
 
 
 ![Developer docs](./assets/developer-docs.png)
@@ -30,7 +30,7 @@ They are defined in the [`.github/workflows`](./.github/workflows/) folder and h
 
 ### Grammar and language check
 
-All changed content is checked with Reviewdog for grammar and language. The configuration for Reviewdog can be found in [`.reviewdog.yml`](./.github/workflows/reviewdog.yml). It will create warnings in the pull request if the language or grammar is not correct. A more in-depth explanation can be found in [Language and Grammar](./resources/guidelines/documentation-guidelines/03-language-and-grammar.md) section.
+All changed content is checked with Reviewdog for grammar and language. The configuration for Reviewdog can be found in [`.reviewdog.yml`](./.github/workflows/reviewdog.yml). It will create warnings in the pull request if the language or grammar is not correct. A more in-depth explanation can be found in [Language and Grammar](fundamentals/non-functional-req/documentation/developer-documentation/03-language-and-grammar.md) section.
 
 ### Markdown check
 
@@ -46,7 +46,7 @@ sort .wordlist.txt -o .wordlist.txt
 
 ### Media file format check
 
-The `/docs/assets` folder stores images, videos, and other files linked in markdown. They follow the naming convention outlined in [Methodize Assets](./resources/guidelines/documentation-guidelines/05-methodize-assets.md#visual-diagram-guidelines). The [`file-format-check.yml`](.github/workflows/file-format-check.yml) ensures adherence to these naming guidelines.
+The `/docs/assets` folder stores images, videos, and other files linked in markdown. They follow the naming convention outlined in [Methodize Assets](fundamentals/non-functional-req/documentation/developer-documentation/05-methodize-assets.md#visual-diagram-guidelines). The [`file-format-check.yml`](.github/workflows/file-format-check.yml) ensures adherence to these naming guidelines.
 
 ### External link check
 

concepts/index.md

@@ -0,0 +1,6 @@
+---
+nav:
+  title: Concepts
+  position: 10
+---
+# Concepts

fundamentals/ci-cd/index.md

@@ -0,0 +1,6 @@
+---
+nav:
+  title: CI / CD
+  position: 30
+---
+# Continuous Integration & Delivery

fundamentals/development/index.md

@@ -0,0 +1,6 @@
+---
+nav:
+  title: Development
+  position: 40
+---
+# Development & Coding Guidelines

fundamentals/index.md

@@ -0,0 +1,6 @@
+---
+nav:
+  title: Engineering Fundamentals
+  position: 60
+---
+# Engineering Fundamentals

resources/accessibility/storefront/index.md → fundamentals/non-functional-req/Accessibility.md

@@ -1,7 +1,7 @@
 ---
 nav:
-  title: Storefront
-  position: 30
+  title: Accessibility
+  position: 50
 ---
 
 # Accessibility in the Storefront

resources/guidelines/documentation-guidelines/04-fonts-and-formats/02-code.md → fundamentals/non-functional-req/documentation/developer-documentation/code-format.md

@@ -1,8 +1,7 @@
 ---
 nav:
-  title: Code
-  position: 20
-
+  title: Code Format
+  position: 60
 ---
 
 # Fonts and Format for Code

resources/guidelines/documentation-guidelines/02-conceptual-structure.md → fundamentals/non-functional-req/documentation/developer-documentation/conceptual-structure.md

@@ -1,8 +1,7 @@
 ---
 nav:
   title: Conceptual Structure
-  position: 20
-
+  position: 10
 ---
 
 # Conceptual Outline

resources/guidelines/documentation-guidelines/06-doc-process.md → fundamentals/non-functional-req/documentation/developer-documentation/doc-process.md

@@ -1,8 +1,7 @@
 ---
 nav:
-  title: Doc Process
-  position: 20
-
+  title: Documentation Process
+  position: 70
 ---
 
 # Documentation Process

resources/guidelines/documentation-guidelines/07-embedding-external-repositories.md → fundamentals/non-functional-req/documentation/developer-documentation/embedding-external-repositories.md

@@ -1,3 +1,9 @@
+---
+nav:
+  title: Embedding Repositories
+  position: 80
+---
+
 # Embedding external repositories
 
 This guide will explain how to embed project documentation from your repository into the [Developer documentation](https://developer.shopware.com/frontends/).

resources/guidelines/documentation-guidelines/01-general.md → fundamentals/non-functional-req/documentation/developer-documentation/index.md

@@ -1,8 +1,7 @@
 ---
 nav:
-  title: General
-  position: 10
-
+  title: Developer Documentation
+  position: 40
 ---
 
 # Documentation Guidelines

resources/guidelines/documentation-guidelines/03-language-and-grammar.md → fundamentals/non-functional-req/documentation/developer-documentation/language-and-grammar.md

@@ -1,8 +1,7 @@
 ---
 nav:
   title: Language & Grammar
-  position: 30
-
+  position: 40
 ---
 
 # Language and Grammar

resources/guidelines/documentation-guidelines/05-methodize-assets.md → fundamentals/non-functional-req/documentation/developer-documentation/methodize-assets.md

@@ -1,8 +1,7 @@
 ---
 nav:
   title: Methodize Assets
-  position: 10
-
+  position: 30
 ---
 
 # Methodize Assets

resources/guidelines/documentation-guidelines/04-fonts-and-formats/01-text.md → fundamentals/non-functional-req/documentation/developer-documentation/text-format.md

@@ -1,8 +1,7 @@
 ---
 nav:
-  title: Text
-  position: 10
-
+  title: Text Format
+  position: 50
 ---
 
 # Fonts and Format for Text

fundamentals/non-functional-req/documentation/index.md

@@ -0,0 +1,6 @@
+---
+nav:
+  title: Documentation
+  position: 90
+---
+# Documentation

fundamentals/non-functional-req/index.md

@@ -0,0 +1,6 @@
+---
+nav:
+  title: Non-functional Requirements
+  position: 60
+---
+# Non-functional Requirements

fundamentals/pull-requests/index.md

@@ -0,0 +1,6 @@
+---
+nav:
+  title: Pull Requests
+  position: 20
+---
+# Pull Requests

resources/references/security.md → fundamentals/security/application-security.md

@@ -1,11 +1,10 @@
 ---
 nav:
-  title: Security
+  title: Application Security
   position: 10
-
 ---
 
-# Security
+# Application Security
 
 ## Overview
 

fundamentals/security/index.md

@@ -0,0 +1,6 @@
+---
+nav:
+  title: Security
+  position: 70
+---
+# Security

fundamentals/source-control/index.md

@@ -0,0 +1,6 @@
+---
+nav:
+  title: Source Control
+  position: 10
+---
+# Source Control

resources/guidelines/testing/e2e-best-practises.md → fundamentals/testing/e2e-testing/e2e-best-practises.md

@@ -1,8 +1,7 @@
 ---
 nav:
-  title: Best practices on writing end-to-end tests
+  title: Best Practices
   position: 10
-
 ---
 
 # Best practices for writing end-to-end tests

fundamentals/testing/e2e-testing/index.md

@@ -0,0 +1,6 @@
+---
+nav:
+  title: E2E Testing
+  position: 30
+---
+# End-to-End Testing

fundamentals/testing/index.md

@@ -0,0 +1,6 @@
+---
+nav:
+  title: Testing
+  position: 50
+---
+# Testing

resources/guidelines/testing/store/quality-guidelines-apps/index.md → fundamentals/testing/testing-extensions/app-quality-guide.md

@@ -1,8 +1,7 @@
 ---
 nav:
-  title: Quality guidelines for apps in app system
+  title: Quality guidelines for apps
   position: 10
-
 ---
 
 # Quality Guidelines for Apps and Themes based on App System in Shopware Store
@@ -67,8 +66,8 @@ We always test with the [actual SW6 version](https://www.shopware.com/de/downloa
 
 * [Sample app development template](https://github.com/shopwareLabs/AppExample)
 * [App base guide](/docs/guides/plugins/apps/app-base-guide)
-* [Storefront](../../../../../guides/plugins/apps/storefront/index.md)
-* [Admin](../../../../../guides/plugins/apps/administration/index.md)
+* [Storefront](../../../guides/plugins/apps/storefront/index.md)
+* [Admin](../../../guides/plugins/apps/administration/index.md)
 
 ## Checklist for app testing
 

resources/guidelines/testing/Differentiator-Clusters.md → fundamentals/testing/testing-extensions/differentiator-clusters.md

@@ -1,3 +1,9 @@
+---
+nav:
+  title: Differentiator cluster for Shopware extensions
+  position: 30
+---
+
 # Differentiator cluster for Shopware extensions
 
 This section will show you the new differentiator groups which needs to be fulfilled to be to released to the store .

resources/guidelines/testing/store/index.md → fundamentals/testing/testing-extensions/index.md

@@ -1,13 +1,17 @@
 ---
 nav:
-  title: Testing guidelines for extensions
-  position: 10
-
+  title: Testing of Extensions
+  position: 80
 ---
 
 # Testing Guidelines for Shopware Extensions
 
-This section guides you with the criteria used to test your extension. Detailed information is available on [quality guidelines for apps](../store/quality-guidelines-apps/),[quality guidelines for plugins](../store/quality-guidelines-plugins/) and [differentiator cluster](../Differentiator-Clusters.html).
+This section guides you with the criteria used to test your extension. 
+
+Detailed information is available on:
+* [Quality guidelines for Apps](./app-quality-guide.html)
+* [Quality guidelines for Plugins](./plugin-quality-guide.html)
+* [Differentiator Cluster](./differentiator-clusters.html)
 
 Check out the points that affect your extension and go through them before submitting it for testing.
 

resources/guidelines/testing/store/quality-guidelines-plugins/index.md → fundamentals/testing/testing-extensions/plugin-quality-guide.md

@@ -1,8 +1,7 @@
 ---
 nav:
-  title: Quality guidelines for apps in the plugin system
-  position: 10
-
+  title: Quality guidelines for plugins
+  position: 20
 ---
 
 # Quality Guidelines for the Plugin System in the Shopware Store

guides/index.md

@@ -0,0 +1,6 @@
+---
+nav:
+  title: Guides
+  position: 20
+---
+# Guides

package.json

@@ -5,5 +5,6 @@
     "docs:env": "[ -d \"../developer-portal\" ] && ../developer-portal/docs-cli.cjs pull || (git clone [email protected]:shopware/developer-portal.git ../developer-portal && pnpm i -C ../developer-portal)",
     "docs:link": "../developer-portal/docs-cli.cjs link --src . --dst docs --symlink",
     "docs:preview": "../developer-portal/docs-cli.cjs preview"
-  }
+  },
+  "packageManager": "[email protected]+sha512.cce0f9de9c5a7c95bef944169cc5dfe8741abfb145078c0d508b868056848a87c81e626246cb60967cbd7fd29a6c062ef73ff840d96b3c86c40ac92cf4a813ee"
 }

products/community-edition.md

@@ -45,4 +45,4 @@ This video is part of our online training, the [Backend Development](https://aca
 
 ## Contribution
 
-Shopware 6 is a community-driven platform with a lot of contributions, and we really appreciate your support. To ensure the quality of our code, our products and our documentation, we have created a small guideline for contributing [Code](../resources/guidelines/code/contribution) and contributing to the [Docs](../resources/guidelines/documentation-guidelines/) we all should endorse to. It helps you and us to collaborate with our software. Following these guidelines will help us to integrate your changes in our daily workflow.
+Shopware 6 is a community-driven platform with a lot of contributions, and we really appreciate your support. To ensure the quality of our code, our products and our documentation, we have created a small guideline for contributing [Code](../resources/guidelines/code/contribution) and contributing to the [Docs](../fundamentals/non-functional-req/documentation/developer-documentation/) we all should endorse to. It helps you and us to collaborate with our software. Following these guidelines will help us to integrate your changes in our daily workflow.

products/index.md

@@ -0,0 +1,6 @@
+---
+nav:
+  title: Products
+  position: 30
+---
+# Products

resources/index.md

@@ -0,0 +1,6 @@
+---
+nav:
+  title: Resources
+  position: 40
+---
+# Resources