From 768eb1c4c04b9b8f50965f872bf5c3dc1a864869 Mon Sep 17 00:00:00 2001 From: Grzegorz Leoniec Date: Wed, 28 Nov 2018 11:21:24 +0000 Subject: [PATCH] GitBook: [master] 38 pages modified --- README.md | 4 --- SUMMARY.md | 36 +++++++++---------- {api => backend}/data-import.md | 0 .../graphql-with-apollo/README.md | 4 --- .../graphql-with-apollo/mocking.md | 4 --- .../graphql-with-apollo/seeding.md | 2 +- {api => backend}/installation/README.md | 4 --- .../installation/configuration.md | 0 {api => backend}/installation/docker.md | 0 {api => backend}/middleware.md | 7 ---- {api => backend}/todos.md | 6 ++++ frontend/todos.md | 3 -- {frontend => web-frontend}/installation.md | 0 {frontend => web-frontend}/styleguide.md | 4 --- web-frontend/todos.md | 8 +++++ {integration-tests => workflow}/deployment.md | 2 ++ .../pull-requests.md | 2 ++ .../testing/README.md | 4 --- .../testing/component-testing.md | 2 ++ .../testing/integration-testing.md | 6 ---- .../testing/unit-testing.md | 2 ++ 21 files changed, 41 insertions(+), 59 deletions(-) rename {api => backend}/data-import.md (100%) rename {api => backend}/graphql-with-apollo/README.md (90%) rename {api => backend}/graphql-with-apollo/mocking.md (83%) rename {api => backend}/graphql-with-apollo/seeding.md (91%) rename {api => backend}/installation/README.md (93%) rename {api => backend}/installation/configuration.md (100%) rename {api => backend}/installation/docker.md (100%) rename {api => backend}/middleware.md (80%) rename {api => backend}/todos.md (71%) delete mode 100644 frontend/todos.md rename {frontend => web-frontend}/installation.md (100%) rename {frontend => web-frontend}/styleguide.md (92%) create mode 100644 web-frontend/todos.md rename {integration-tests => workflow}/deployment.md (87%) rename {integration-tests => workflow}/pull-requests.md (89%) rename {integration-tests => workflow}/testing/README.md (90%) rename {integration-tests => workflow}/testing/component-testing.md (91%) rename {integration-tests => workflow}/testing/integration-testing.md (90%) rename {integration-tests => workflow}/testing/unit-testing.md (88%) diff --git a/README.md b/README.md index 34f12aacf..f9131771d 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,3 @@ ---- -description: Welcome to the Human-Connection Nitro Documentation. ---- - # Let's change the World ## Why do we need HC Nitro? diff --git a/SUMMARY.md b/SUMMARY.md index 314e74789..7684d6905 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -4,30 +4,30 @@ ## Backend -* [Backend Installation](api/installation/README.md) - * [Configuration](api/installation/configuration.md) - * [Docker](api/installation/docker.md) -* [GraphQL with Apollo](api/graphql-with-apollo/README.md) - * [Mocking](api/graphql-with-apollo/mocking.md) - * [Seeding](api/graphql-with-apollo/seeding.md) -* [Middleware](api/middleware.md) -* [Import](api/data-import.md) -* [Todo's](api/todos.md) +* [Backend Installation](backend/installation/README.md) + * [Configuration](backend/installation/configuration.md) + * [Docker](backend/installation/docker.md) +* [GraphQL with Apollo](backend/graphql-with-apollo/README.md) + * [Mocking](backend/graphql-with-apollo/mocking.md) + * [Seeding](backend/graphql-with-apollo/seeding.md) +* [Middleware](backend/middleware.md) +* [Import](backend/data-import.md) +* [Todo's](backend/todos.md) ## Web Frontend -* [Web Installation](frontend/installation.md) -* [Styleguide](frontend/styleguide.md) -* [Todo's](frontend/todos.md) +* [Web Installation](web-frontend/installation.md) +* [Styleguide](web-frontend/styleguide.md) +* [Todo's](web-frontend/todos.md) ## Workflow -* [Testing Guide](integration-tests/testing/README.md) - * [Integration Testing](integration-tests/testing/integration-testing.md) - * [Component Testing](integration-tests/testing/component-testing.md) - * [Unit Testing](integration-tests/testing/unit-testing.md) -* [Pull-Requests](integration-tests/pull-requests.md) -* [Deployment](integration-tests/deployment.md) +* [Testing Guide](workflow/testing/README.md) + * [Integration Testing](workflow/testing/integration-testing.md) + * [Component Testing](workflow/testing/component-testing.md) + * [Unit Testing](workflow/testing/unit-testing.md) +* [Pull-Requests](workflow/pull-requests.md) +* [Deployment](workflow/deployment.md) ## Recources diff --git a/api/data-import.md b/backend/data-import.md similarity index 100% rename from api/data-import.md rename to backend/data-import.md diff --git a/api/graphql-with-apollo/README.md b/backend/graphql-with-apollo/README.md similarity index 90% rename from api/graphql-with-apollo/README.md rename to backend/graphql-with-apollo/README.md index 018330259..cbea05e36 100644 --- a/api/graphql-with-apollo/README.md +++ b/backend/graphql-with-apollo/README.md @@ -1,7 +1,3 @@ ---- -description: Our API Layer ---- - # GraphQL with Apollo GraphQL is a data query language which provides an alternative to REST and ad-hoc web service architectures. It allows clients to define the structure of the data required, and exactly the same structure of the data is returned from the server. diff --git a/api/graphql-with-apollo/mocking.md b/backend/graphql-with-apollo/mocking.md similarity index 83% rename from api/graphql-with-apollo/mocking.md rename to backend/graphql-with-apollo/mocking.md index 8b99ea6bf..1a22cfe57 100644 --- a/api/graphql-with-apollo/mocking.md +++ b/backend/graphql-with-apollo/mocking.md @@ -1,7 +1,3 @@ ---- -description: No Database? No problem! ---- - # Mocking ### Mocking API Results diff --git a/api/graphql-with-apollo/seeding.md b/backend/graphql-with-apollo/seeding.md similarity index 91% rename from api/graphql-with-apollo/seeding.md rename to backend/graphql-with-apollo/seeding.md index 1f3615666..010607477 100644 --- a/api/graphql-with-apollo/seeding.md +++ b/backend/graphql-with-apollo/seeding.md @@ -1,6 +1,6 @@ # Seeding -### Seeding The Database +## Seeding The Database Optionally you can seed the GraphQL service by executing mutations that will write sample data to the database: diff --git a/api/installation/README.md b/backend/installation/README.md similarity index 93% rename from api/installation/README.md rename to backend/installation/README.md index 07ebe2da2..b4a1b43f7 100644 --- a/api/installation/README.md +++ b/backend/installation/README.md @@ -1,7 +1,3 @@ ---- -description: Lets try to install the Human Connection - Nitro Backend ---- - # Backend Installation {% hint style="warning" %} diff --git a/api/installation/configuration.md b/backend/installation/configuration.md similarity index 100% rename from api/installation/configuration.md rename to backend/installation/configuration.md diff --git a/api/installation/docker.md b/backend/installation/docker.md similarity index 100% rename from api/installation/docker.md rename to backend/installation/docker.md diff --git a/api/middleware.md b/backend/middleware.md similarity index 80% rename from api/middleware.md rename to backend/middleware.md index f581097c7..4e7d124be 100644 --- a/api/middleware.md +++ b/backend/middleware.md @@ -1,10 +1,3 @@ ---- -description: >- - GraphQL Middleware lets you run arbitrary code before or after a resolver is - invoked. It improves your code structure by enabling code reuse and a clear - separation of concerns. ---- - # Middleware diff --git a/api/todos.md b/backend/todos.md similarity index 71% rename from api/todos.md rename to backend/todos.md index effb25b3a..b9d44b392 100644 --- a/api/todos.md +++ b/backend/todos.md @@ -1,5 +1,11 @@ +--- +description: Want to help on the Backend / API part? +--- + # Todo's +Github Issues: [https://github.com/Human-Connection/Nitro-Backend/issues](https://github.com/Human-Connection/Nitro-Backend/issues) + * [x] add jwt authentication \(in progress\) * [ ] get directives working correctly \(@toLower, @auth, @role, etc.\) * [ ] check if search is working diff --git a/frontend/todos.md b/frontend/todos.md deleted file mode 100644 index e503852a5..000000000 --- a/frontend/todos.md +++ /dev/null @@ -1,3 +0,0 @@ -# Todo's - -* [ ] diff --git a/frontend/installation.md b/web-frontend/installation.md similarity index 100% rename from frontend/installation.md rename to web-frontend/installation.md diff --git a/frontend/styleguide.md b/web-frontend/styleguide.md similarity index 92% rename from frontend/styleguide.md rename to web-frontend/styleguide.md index 5c0983dae..13a291861 100644 --- a/frontend/styleguide.md +++ b/web-frontend/styleguide.md @@ -1,7 +1,3 @@ ---- -description: 'The styleguide is not just a guide, its also our Design System.' ---- - # Styleguide For this Projoject we decided to use [Jörg Bayreuther's](https://github.com/visualjerk) _\(visualjerk\)_ fantastic Design System called [CION](https://cion.visualjerk.de/). _\(see a_ [_demo_](https://styleguide.cion.visualjerk.de/)_\)_ diff --git a/web-frontend/todos.md b/web-frontend/todos.md new file mode 100644 index 000000000..f3c3d5775 --- /dev/null +++ b/web-frontend/todos.md @@ -0,0 +1,8 @@ +--- +description: 'Want to help? Here you finde the recources for the Web part:' +--- + +# Todo's + +Github Issues: [https://github.com/Human-Connection/Nitro-Web/issues](https://github.com/Human-Connection/Nitro-Web/issues) + diff --git a/integration-tests/deployment.md b/workflow/deployment.md similarity index 87% rename from integration-tests/deployment.md rename to workflow/deployment.md index ed3c9a4c8..049966ff8 100644 --- a/integration-tests/deployment.md +++ b/workflow/deployment.md @@ -1,2 +1,4 @@ # Deployment + + diff --git a/integration-tests/pull-requests.md b/workflow/pull-requests.md similarity index 89% rename from integration-tests/pull-requests.md rename to workflow/pull-requests.md index 2a6eae745..9952ddc26 100644 --- a/integration-tests/pull-requests.md +++ b/workflow/pull-requests.md @@ -1,2 +1,4 @@ # Pull-Requests + + diff --git a/integration-tests/testing/README.md b/workflow/testing/README.md similarity index 90% rename from integration-tests/testing/README.md rename to workflow/testing/README.md index ff86eba03..f99ea73ab 100644 --- a/integration-tests/testing/README.md +++ b/workflow/testing/README.md @@ -1,7 +1,3 @@ ---- -description: Explaniation of the main three testing approaches. ---- - # Testing Guide ## [Integration Testing](integration-testing.md) diff --git a/integration-tests/testing/component-testing.md b/workflow/testing/component-testing.md similarity index 91% rename from integration-tests/testing/component-testing.md rename to workflow/testing/component-testing.md index 3f2b3e2a9..75ba5da08 100644 --- a/integration-tests/testing/component-testing.md +++ b/workflow/testing/component-testing.md @@ -1,2 +1,4 @@ # Component Testing + + diff --git a/integration-tests/testing/integration-testing.md b/workflow/testing/integration-testing.md similarity index 90% rename from integration-tests/testing/integration-testing.md rename to workflow/testing/integration-testing.md index 267aef088..a4d217bb2 100644 --- a/integration-tests/testing/integration-testing.md +++ b/workflow/testing/integration-testing.md @@ -1,9 +1,3 @@ ---- -description: >- - Here you can find information on how we are testing the whole application - automaicaly. ---- - # Integration Testing ## Install Cypress diff --git a/integration-tests/testing/unit-testing.md b/workflow/testing/unit-testing.md similarity index 88% rename from integration-tests/testing/unit-testing.md rename to workflow/testing/unit-testing.md index 600973450..5b3ffcad1 100644 --- a/integration-tests/testing/unit-testing.md +++ b/workflow/testing/unit-testing.md @@ -1,2 +1,4 @@ # Unit Testing + +