IT4Change/Ocelot-Social
3
0
Fork 0
mirror of https://github.com/IT4Change/Ocelot-Social.git synced 2026-04-27 15:09:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

adapt tabsmarkdown to vuepress

Browse Source
This commit is contained in:
mahula 2023-11-20 13:01:56 +01:00
parent 09aba642ae
commit c6c1b81437
5 changed files with 42 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
backend/README.md
View File

@ -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: Database indexes and constraints need to be created and upgraded when the database and the backend are running:
{% tabs %} ::: tabs
{% tab title="Docker" %} @tab:active Docker
```bash ```bash
# in main folder while docker-compose is running # 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 $ docker exec backend yarn run db:migrate up
``` ```
{% endtab %} @tab Without Docker
{% tab title="Without Docker" %}
```bash ```bash
# in folder backend/ while database is running # in folder backend/ while database is running
@ -116,16 +115,15 @@ yarn run db:migrate init
yarn run db:migrate up yarn run db:migrate up
``` ```
{% endtab %} :::
{% endtabs %}
#### Seed Database #### Seed Database
If you want your backend to return anything else than an empty response, you If you want your backend to return anything else than an empty response, you
need to seed your database: need to seed your database:
{% tabs %} ::: tabs
{% tab title="Docker" %} @tab:active Docker
In another terminal run: In another terminal run:
@ -147,8 +145,7 @@ $ docker exec backend yarn run db:migrate init
$ docker exec backend yarn run db:migrate up $ docker exec backend yarn run db:migrate up
``` ```
{% endtab %} @tab Without Docker
{% tab title="Without Docker" %}
Run: Run:
@ -164,16 +161,15 @@ To reset the database run:
$ yarn run db:reset $ yarn run db:reset
``` ```
{% endtab %} :::
{% endtabs %}
### Data migrations ### Data migrations
Although Neo4J is schema-less,you might find yourself in a situation in which 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. you have to migrate your data e.g. because your data modeling has changed.
{% tabs %} ::: tabs
{% tab title="Docker" %} @tab:active Docker
Generate a data migration file: Generate a data migration file:
@ -190,8 +186,7 @@ To run the migration:
$ docker exec backend yarn run db:migrate up $ docker exec backend yarn run db:migrate up
``` ```
{% endtab %} @tab Without Docker
{% tab title="Without Docker" %}
Generate a data migration file: Generate a data migration file:
@ -208,16 +203,15 @@ To run the migration:
$ yarn run db:migrate up $ yarn run db:migrate up
``` ```
{% endtab %} :::
{% endtabs %}
## Testing ## Testing
**Beware**: We have no multiple database setup at the moment. We clean the **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! database after each test, running the tests will wipe out all your data!
{% tabs %} ::: tabs
{% tab title="Docker" %} @tab:active Docker
Run the unit tests: Run the unit tests:
@ -226,9 +220,7 @@ Run the unit tests:
$ docker exec backend yarn run test $ docker exec backend yarn run test
``` ```
{% endtab %} @tab Without Docker
{% tab title="Without Docker" %}
Run the unit tests: Run the unit tests:
@ -237,5 +229,4 @@ Run the unit tests:
$ yarn run test $ yarn run test
``` ```
{% endtab %} :::
{% endtabs %}

10
deployment/src/old/digital-ocean/https/README.md
View File

@ -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. And to create a load balancer costs money. Please refine the following documentation if required.
{% endhint %} {% endhint %}
{% tabs %} ::: tabs
{% tab title="Without Load Balancer" %} @tab:active Without Load Balancer
A solution without a load balance you can find [here](../no-loadbalancer/README.md). A solution without a load balance you can find [here](../no-loadbalancer/README.md).
{% endtab %} @tab With DigitalOcean Load Balancer
{% tab title="With DigitalOcean Load Balancer" %}
{% hint style="info" %} {% hint style="info" %}
CAUTION: It seems that the behaviour of DigitalOcean has changed and the load balancer is not created automatically anymore. 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. 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`. 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: Check the ingress server is working correctly:

29
edit-this-documentation.md
View File

@ -29,17 +29,15 @@ To design your documentation see the syntax description at GitBook:
#### Tabs #### Tabs
```markdown ```markdown
{% tabs %} ::: tabs
{% tab title="XXX" %} @tab:active First tab's title <!-- this tab is setactive -->
XXX
{% endtab %} @tab Second tab's title
{% tab title="XXX" %}
XXX :::
{% endtab %}
…
{% endtabs %}
``` ```
#### Commands #### Commands
~~~markdown ~~~markdown
@ -92,23 +90,22 @@ Copy the URL and paste it were you need it.
### Add an Arrow or some other Marking Stuff ### Add an Arrow or some other Marking Stuff
{% tabs %} ::: tabs
{% tab title="macOS" %} @tab:active macOS
#### In the Preview App #### In the Preview App
Got to: **Menu** + **Tools** \(GER: Werkzeuge\) + **Annotate** \(GER: Anmerkungen\) + etc. Got to: **Menu** + **Tools** \(GER: Werkzeuge\) + **Annotate** \(GER: Anmerkungen\) + etc.
{% endtab %}
{% tab title="Windows" %} @tab Windows
{% hint style="info" %} {% hint style="info" %}
TODO: How to modify screenshots in Windows ... TODO: How to modify screenshots in Windows ...
{% endhint %} {% endhint %}
{% endtab %} {% endtab %}
{% tab title="Linux" %} @tab Linux
{% hint style="info" %} {% hint style="info" %}
TODO: How to modify screenshots in Linux ... TODO: How to modify screenshots in Linux ...
{% endhint %} {% endhint %}
{% endtab %} :::
{% endtabs %}

11
webapp/README.md
View File

@ -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: For more information see our [frontend testing guide](testing.md). Use these commands to run the tests:
{% tabs %} ::: tabs
{% tab title="With Docker" %} @tab:active With Docker
After starting the application following the above guidelines, open new terminal windows for each of these commands: 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` 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: 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` You can then visit the Storybook playground on `http://localhost:3002`
{% endtab %} :::
{% endtabs %}
## Maintenance Mode ## Maintenance Mode

9
webapp/maintenance/README.md
View File

@ -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. At the moment the maintenance mode can only be locally tested with Docker-Compose.
{% tabs %} ::: tabs
{% tab title="Locally Without Docker" %} @tab:active Locally Without Docker
{% hint style="info" %} {% hint style="info" %}
TODO: Implement a locally running maintenance mode! Without Docker … TODO: Implement a locally running maintenance mode! Without Docker …
@ -25,8 +25,7 @@ $ yarn generate:maintenance
… is unfortunatelly **not(!)** working at the moment. … 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. This is because the code is rewritten to be easy usable for Docker-Compose. Therefore we lost this possibility.
{% endtab %} @tab Locally With Docker
{% tab title="Locally With Docker" %}
To get the maintenance mode running use the command: 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. 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/`. In the browser you can reach it under `http://localhost:3001/`.
:::