OPENEUROPA-565 - Patterns and References - Refactoring of public docu… (

#9) * OPENEUROPA-565 - Patterns and References - Refactoring of public documentation * OPENEUROPA-565: Fixed minor types found during PR review * OPENEUROPA-565: Adding missing file regarding the development workflow. * OPENEUROPA-565: Remove orphan documentation files from previous structure
openeuropa · May 18, 2018 · e646601 · e646601
1 parent 91e6105
commit e646601
Show file tree

Hide file tree

Showing 26 changed files with 67 additions and 21 deletions.
diff --git a/README.md b/README.md
@@ -14,11 +14,38 @@ In order to achieve such a goal the OpenEuropa Initiative will focus on the foll
 
 For more information please check:
 
-- [OpenEuropa components](docs/openeuropa-components.md)
-- [How to contribute](docs/how-to-contribute.md)
-- [Coding standards](docs/coding-standards.md)
-- [Release cycle](docs/release-cycle.md)
-- [Third party open source](docs/third-party-open-source.md)
+* OpenEuropa initiative
+  * [Code of Conduct](docs/initiative/code-of-conduct.md) 
+  * [Release cycle](docs/initiative/release-cycle.md)
+  * [How to contribute](docs/initiative/how-to-contribute.md)
+* [OpenEuropa components](docs/openeuropa-components.md)  
+* Before you start
+  * [Repositories architecture](docs/starting/repository-architecture.md)
+  * [Dependency management](docs/starting/dependency-management-and-patching.md)
+  * [Tooling](docs/starting/tooling.md)
+* Architecture
+  * Third party
+    * Drupal
+      * [Content architecture](docs/architecture/third-party/drupal/content-architecture.md)
+      * [Layout architecture](docs/architecture/third-party/drupal/layout-architecture.md)  
+      * [Configuration management](docs/architecture/third-party/drupal/configuration-management.md)
+      * [Module selection](docs/architecture/third-party/drupal/selecting-contributed-modules.md)
+      * [Experimental modules policy](docs/architecture/third-party/drupal/experimental-module-policy.md)
+* Development
+  * [Development Workflow](docs/development/development-workflow.md)
+  * [Feature development guidelines](docs/development/feature-development.md)
+  * [Coding standards](docs/development/coding-standards.md)
+  * [Frontend development](docs/development/frontend/index.md)
+  * Third party development
+    * [Drupal](docs/development/third-party/drupal/index.md)
+  * [CI And deployment workflow](docs/development/ci-deployment-workflow.md)
+  * [Release workflow](docs/development/release-workflow.md)
+  * Templates
+    * [Issue template](docs/templates/issue-template.md)
+    * [Pull request template](docs/templates/pull-request-template.md)
+* Testing
+  * [Types of testing](docs/testing/types-of-testing.md)
+  * [Running tests](docs/testing/runnning-tests.md)
 
 [1]: https://ec.europa.eu/info/departments/informatics
 [2]: https://opensource.org

diff --git a/docs/architecture/third-party/drupal/configuration-management.md b/docs/architecture/third-party/drupal/configuration-management.md
@@ -0,0 +1 @@
+-- TO BE DEFINED --
diff --git a/docs/architecture/third-party/drupal/content-architecture.md b/docs/architecture/third-party/drupal/content-architecture.md
@@ -0,0 +1 @@
+-- TO BE DEFINED --
diff --git a/...arty/drupal/experimental-module-policy.md → ...arty/drupal/experimental-module-policy.md b/...arty/drupal/experimental-module-policy.md → ...arty/drupal/experimental-module-policy.md
diff --git a/docs/architecture/third-party/drupal/layout-architecture.md b/docs/architecture/third-party/drupal/layout-architecture.md
@@ -0,0 +1 @@
+-- TO BE DEFINED --
diff --git a/docs/architecture/third-party/drupal/selecting-contributed-modules.md b/docs/architecture/third-party/drupal/selecting-contributed-modules.md
@@ -0,0 +1 @@
+-- TO BE DEFINED --
diff --git a/docs/development/ci-deployment-workflow.md b/docs/development/ci-deployment-workflow.md
@@ -0,0 +1,7 @@
+
+# CI Deployment Workflow
+
+OpenEuropa is using [Drone][1] for continuous integration and continuous delivery.
+For more information about Drone please check [Drone](docs/development/third-party/drone.md)]
+
+[1]: https://drone.io
diff --git a/docs/coding-standards.md → docs/development/coding-standards.md b/docs/coding-standards.md → docs/development/coding-standards.md
diff --git a/docs/development/development-workflow.md b/docs/development/development-workflow.md
@@ -0,0 +1 @@
+-- TO BE DEFINED --
diff --git a/docs/development/feature-development.md b/docs/development/feature-development.md
@@ -0,0 +1,15 @@
+# Feature implementation
+
+Definition of mandatory steps of feature development
+
+-- TO BE DEFINED --
+
+## Purpose and scope
+
+## Implementation
+
+## Reviewing performance/security/configuration management
+
+## Feature Documentation	
+			
+## Feature Test coverage
diff --git a/docs/development/frontend/index.md b/docs/development/frontend/index.md
@@ -0,0 +1 @@
+-- TO BE DEFINED --
diff --git a/docs/development/release-workflow.md b/docs/development/release-workflow.md
@@ -0,0 +1 @@
+-- TO BE DEFINED --
diff --git a/docs/third-party/drone.md → docs/development/third-party/drone.md b/docs/third-party/drone.md → docs/development/third-party/drone.md
diff --git a/docs/development/third-party/drupal/index.md b/docs/development/third-party/drupal/index.md
@@ -0,0 +1 @@
+-- TO BE DEFINED --
diff --git a/docs/code-of-conduct.md → docs/initiative/code-of-conduct.md b/docs/code-of-conduct.md → docs/initiative/code-of-conduct.md
diff --git a/docs/how-to-contribute.md → docs/initiative/how-to-contribute.md b/docs/how-to-contribute.md → docs/initiative/how-to-contribute.md
diff --git a/docs/release-cycle.md → docs/initiative/release-cycle.md b/docs/release-cycle.md → docs/initiative/release-cycle.md
diff --git a/docs/starting/dependency-management-and-patching.md b/docs/starting/dependency-management-and-patching.md
@@ -0,0 +1 @@
+-- TO BE DEFINED --
diff --git a/docs/starting/repository-architecture.md b/docs/starting/repository-architecture.md
@@ -0,0 +1 @@
+-- TO BE DEFINED --
diff --git a/docs/starting/tooling.md b/docs/starting/tooling.md
@@ -0,0 +1 @@
+-- TO BE DEFINED --
diff --git a/docs/issue-template.md → docs/templates/issue-template.md b/docs/issue-template.md → docs/templates/issue-template.md
diff --git a/docs/pull-request-template.md → docs/templates/pull-request-template.md b/docs/pull-request-template.md → docs/templates/pull-request-template.md
diff --git a/docs/testing/runnning-tests.md b/docs/testing/runnning-tests.md
@@ -0,0 +1 @@
+-- TO BE DEFINED --
diff --git a/docs/testing/types-of-testing.md b/docs/testing/types-of-testing.md
@@ -0,0 +1 @@
+-- TO BE DEFINED --
diff --git a/docs/third-party-open-source.md b/docs/third-party-open-source.md
diff --git a/docs/third-party/drupal.md b/docs/third-party/drupal.md