diff --git a/backend/README.md b/backend/README.md index 98b0e7218..b67b44240 100644 --- a/backend/README.md +++ b/backend/README.md @@ -83,8 +83,8 @@ More details about our GraphQL playground and how to use it with ocelot.social c Database indexes and constraints need to be created and upgraded when the database and the backend are running: -{% tabs %} -{% tab title="Docker" %} +::: tabs +@tab:active Docker ```bash # in main folder while docker-compose is running @@ -102,8 +102,7 @@ $ docker compose exec backend /bin/sh -c "yarn prod:migrate init" $ docker exec backend yarn run db:migrate up ``` -{% endtab %} -{% tab title="Without Docker" %} +@tab Without Docker ```bash # in folder backend/ while database is running @@ -116,16 +115,15 @@ yarn run db:migrate init yarn run db:migrate up ``` -{% endtab %} -{% endtabs %} +::: #### Seed Database If you want your backend to return anything else than an empty response, you need to seed your database: -{% tabs %} -{% tab title="Docker" %} +::: tabs +@tab:active Docker In another terminal run: @@ -147,8 +145,7 @@ $ docker exec backend yarn run db:migrate init $ docker exec backend yarn run db:migrate up ``` -{% endtab %} -{% tab title="Without Docker" %} +@tab Without Docker Run: @@ -164,16 +161,15 @@ To reset the database run: $ yarn run db:reset ``` -{% endtab %} -{% endtabs %} +::: ### Data migrations Although Neo4J is schema-less,you might find yourself in a situation in which you have to migrate your data e.g. because your data modeling has changed. -{% tabs %} -{% tab title="Docker" %} +::: tabs +@tab:active Docker Generate a data migration file: @@ -190,8 +186,7 @@ To run the migration: $ docker exec backend yarn run db:migrate up ``` -{% endtab %} -{% tab title="Without Docker" %} +@tab Without Docker Generate a data migration file: @@ -208,16 +203,15 @@ To run the migration: $ yarn run db:migrate up ``` -{% endtab %} -{% endtabs %} +::: ## Testing **Beware**: We have no multiple database setup at the moment. We clean the database after each test, running the tests will wipe out all your data! -{% tabs %} -{% tab title="Docker" %} +::: tabs +@tab:active Docker Run the unit tests: @@ -226,9 +220,7 @@ Run the unit tests: $ docker exec backend yarn run test ``` -{% endtab %} - -{% tab title="Without Docker" %} +@tab Without Docker Run the unit tests: @@ -237,5 +229,4 @@ Run the unit tests: $ yarn run test ``` -{% endtab %} -{% endtabs %} +::: diff --git a/deployment/src/old/digital-ocean/https/README.md b/deployment/src/old/digital-ocean/https/README.md index 8cfaabde4..2393f3a0f 100644 --- a/deployment/src/old/digital-ocean/https/README.md +++ b/deployment/src/old/digital-ocean/https/README.md @@ -23,13 +23,12 @@ CAUTION: It seems that the behaviour of DigitalOcean has changed and the load ba And to create a load balancer costs money. Please refine the following documentation if required. {% endhint %} -{% tabs %} -{% tab title="Without Load Balancer" %} +::: tabs +@tab:active Without Load Balancer A solution without a load balance you can find [here](../no-loadbalancer/README.md). -{% endtab %} -{% tab title="With DigitalOcean Load Balancer" %} +@tab With DigitalOcean Load Balancer {% hint style="info" %} CAUTION: It seems that the behaviour of DigitalOcean has changed and the load balancer is not created automatically anymore. @@ -44,8 +43,7 @@ address. On DigitalOcean, this is how it should look like: If the load balancer isn't created automatically you have to create it your self on DigitalOcean under Networks. In case you don't need a DigitalOcean load balancer (which costs money by the way) have a look in the tab `Without Load Balancer`. -{% endtab %} -{% endtabs %} +::: Check the ingress server is working correctly: diff --git a/edit-this-documentation.md b/edit-this-documentation.md index 5353688bd..b0891de43 100644 --- a/edit-this-documentation.md +++ b/edit-this-documentation.md @@ -29,17 +29,15 @@ To design your documentation see the syntax description at GitBook: #### Tabs ```markdown -{% tabs %} -{% tab title="XXX" %} -XXX -{% endtab %} -{% tab title="XXX" %} -XXX -{% endtab %} -… -{% endtabs %} +::: tabs +@tab:active First tab's title + +@tab Second tab's title + +::: ``` + #### Commands ~~~markdown @@ -92,23 +90,22 @@ Copy the URL and paste it were you need it. ### Add an Arrow or some other Marking Stuff -{% tabs %} -{% tab title="macOS" %} +::: tabs +@tab:active macOS #### In the Preview App Got to: **Menu** + **Tools** \(GER: Werkzeuge\) + **Annotate** \(GER: Anmerkungen\) + etc. -{% endtab %} -{% tab title="Windows" %} +@tab Windows + {% hint style="info" %} TODO: How to modify screenshots in Windows ... {% endhint %} {% endtab %} -{% tab title="Linux" %} +@tab Linux {% hint style="info" %} TODO: How to modify screenshots in Linux ... {% endhint %} -{% endtab %} -{% endtabs %} +::: diff --git a/webapp/README.md b/webapp/README.md index 4c56dcc75..0279574e9 100644 --- a/webapp/README.md +++ b/webapp/README.md @@ -59,8 +59,8 @@ We ensure the quality of our frontend code by using For more information see our [frontend testing guide](testing.md). Use these commands to run the tests: -{% tabs %} -{% tab title="With Docker" %} +::: tabs +@tab:active With Docker After starting the application following the above guidelines, open new terminal windows for each of these commands: @@ -81,9 +81,7 @@ $ docker-compose exec webapp yarn storybook You can then visit the Storybook playground on `http://localhost:3002` -{% endtab %} - -{% tab title="Without Docker" %} +@tab title Without Docker After starting the application following the above guidelines, open new terminal windows and navigate to the `/webapp` directory for each of these commands: @@ -109,8 +107,7 @@ $ yarn storybook You can then visit the Storybook playground on `http://localhost:3002` -{% endtab %} -{% endtabs %} +::: ## Maintenance Mode diff --git a/webapp/maintenance/README.md b/webapp/maintenance/README.md index 95c09bae8..077d00356 100644 --- a/webapp/maintenance/README.md +++ b/webapp/maintenance/README.md @@ -8,8 +8,8 @@ The maintenance mode shows a translatable page that tells the user that we are r At the moment the maintenance mode can only be locally tested with Docker-Compose. -{% tabs %} -{% tab title="Locally Without Docker" %} +::: tabs +@tab:active Locally Without Docker {% hint style="info" %} TODO: Implement a locally running maintenance mode! Without Docker … @@ -25,8 +25,7 @@ $ yarn generate:maintenance … is unfortunatelly **not(!)** working at the moment. This is because the code is rewritten to be easy usable for Docker-Compose. Therefore we lost this possibility. -{% endtab %} -{% tab title="Locally With Docker" %} +@tab Locally With Docker To get the maintenance mode running use the command: @@ -37,3 +36,5 @@ $ docker-compose up And the maintenance mode page or service will be started as well in an own container. In the browser you can reach it under `http://localhost:3001/`. + +:::