From 64f276e56ce5ca0f2ab91117abd1de1cef0a1302 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Wolfgang=20Hu=C3=9F?= Date: Thu, 26 Oct 2023 19:04:51 +0200 Subject: [PATCH] Fix divers links etc. in diverse readmes --- README.md | 4 ++-- SUMMARY.md | 12 +++++------- backend/graphql.md | 7 ++++--- backend/src/graphql/GraphQL-Playground.md | 2 ++ backend/testing.md | 1 + edit-this-documentation.md | 21 +++++++++++---------- 6 files changed, 25 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 2a90b6aca..e9656cf86 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ [![Discord Channel](https://img.shields.io/discord/489522408076738561.svg)](https://discord.gg/AJSX9DCSUA) [![Open Source Helpers](https://www.codetriage.com/ocelot-social-community/ocelot-social/badges/users.svg)](https://www.codetriage.com/ocelot-social-community/ocelot-social) -[ocelot.social](https://ocelot.social) is free and open source software program code to run social networks. Its development is supported by a community of programmers and interested network operators. +[Ocelot.social](https://ocelot.social) is free and open source software program code to run social networks. Its development is supported by a community of programmers and interested network operators.

@@ -261,7 +261,7 @@ We give write permissions to every developer who asks for it. Just text us on ### Deployment -Deployment methods can be found in our `deployment` folder described in the deployment [README](./deployment/README.md). +Deployment methods can be found in our `deployment` folder described in the [README](./deployment/README.md). Our branding template is our [stage.ocelot.social](https://github.com/Ocelot-Social-Community/stage.ocelot.social) repository. Place your branding repository inside `deployment/configurations`. diff --git a/SUMMARY.md b/SUMMARY.md index 453a809b4..097da9986 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -6,19 +6,17 @@ * [Backend](backend/README.md) * [GraphQL](backend/graphql.md) * [neo4j-graphql-js](backend/neo4j-graphql-js.md) -* [Webapp](webapp/README.md) +* [Webapp (Frontend)](webapp/README.md) * [Components](webapp/components.md) * [HTML](webapp/html.md) * [SCSS](webapp/scss.md) * [Vue](webapp/vue.md) * [Testing Guide](testing.md) - * [End-to-end tests](cypress/README.md) - * [Frontend tests](webapp/testing.md) - * [Backend tests](backend/testing.md) -* [Docker More Closely](DOCKER_MORE_CLOSELY.md) + * [End-to-end Tests](cypress/README.md) + * [Webapp (Frontend) Tests](webapp/testing.md) + * [Backend Tests](backend/testing.md) * [Deployment](deployment/README.md) * [Contributing](CONTRIBUTING.md) * [Feature Specification](cypress/features.md) -* [Code of conduct](CODE_OF_CONDUCT.md) +* [Code of Conduct](CODE_OF_CONDUCT.md) * [License](LICENSE.md) - diff --git a/backend/graphql.md b/backend/graphql.md index 12cc59e57..f49edb3b8 100644 --- a/backend/graphql.md +++ b/backend/graphql.md @@ -2,12 +2,13 @@ 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. -![GraphQL Playground](../../../.gitbook/assets/graphql-playground%20%281%29.png) +We have a closer description for the [GraphQL Playground](./src/graphql/GraphQL-Playground.md). + +![GraphQL Playground](../.gitbook/assets/graphql-playground%20%281%29.png) ## Middleware keeps resolvers clean -![](../.gitbook/assets/grafik-4.png) - +![Middleware schema](../.gitbook/assets/grafik-4.png) A well-organized codebase is key for the ability to maintain and easily introduce changes into an app. Figuring out the right structure for your code remains a continuous challenge - especially as an application grows and more developers are joining a project. diff --git a/backend/src/graphql/GraphQL-Playground.md b/backend/src/graphql/GraphQL-Playground.md index 33e371eb5..e914ea993 100644 --- a/backend/src/graphql/GraphQL-Playground.md +++ b/backend/src/graphql/GraphQL-Playground.md @@ -1,5 +1,7 @@ # GraphQL Playground +![GraphQL Playground](../../../.gitbook/assets/graphql-playground%20%281%29.png) + ***Attention:** For using the GraphQL Playground set `DEBUG=true` in your backend `.env`, see `.env.template`!* To use GraphQL Playground, we need to know some basics: diff --git a/backend/testing.md b/backend/testing.md index 600973450..a246569e5 100644 --- a/backend/testing.md +++ b/backend/testing.md @@ -1,2 +1,3 @@ # Unit Testing +***TODO:** To be filled in* diff --git a/edit-this-documentation.md b/edit-this-documentation.md index c841b09ca..5353688bd 100644 --- a/edit-this-documentation.md +++ b/edit-this-documentation.md @@ -2,13 +2,13 @@ Find the [**table of contents** for this documentation on GitHub](https://github.com/Ocelot-Social-Community/Ocelot-Social/blob/master/SUMMARY.md) and navigate to the file you need to update. -Click on the **edit pencil** on the right side directly above the text to edit this file on your fork of Human Connection \(HC\). +Click on the **edit pencil** on the right side directly above the text to edit this file in our repository. You can see a preview of your changes by clicking the **Preview changes** tab aside the **Edit file** tab. If you are ready, fill in the **Propose file change** at the end of the webpage. -After that you have to send your change to the HC basis with a pull request. Here make a comment which issue you have fixed. (If you are working on one of our [open issues](https://github.com/Ocelot-Social-Community/Ocelot-Social/issues) please include the number.) +After that you have to compare your change branch to our `master` branch with a pull request. Here make a comment which issue you have fixed. (If you are working on one of our [open issues](https://github.com/Ocelot-Social-Community/Ocelot-Social/issues) please include the number.) ## Markdown your documentation @@ -21,9 +21,9 @@ To design your documentation see the syntax description at GitBook: #### Headlines ```markdown -# Main headline -## Smaller headlines -### Small headlines +# Main Headline +## Smaller Headlines +### Small Headlines ``` #### Tabs @@ -60,15 +60,15 @@ XXX ![XXX](https://XXX) ``` -#### Hints For ToDos +#### Hints for ToDos ```markdown {% hint style="info" %} TODO: XXX {% endhint %} ``` -## Host The Screenshots +## Host the Screenshots -### Host On Ocelot-Social \(GitHub\) repository +### Host on Ocelot-Social \(GitHub\) Repository {% hint style="info" %} TODO: How to host on Ocelot-Social \(GitHub\) repository ... @@ -88,12 +88,13 @@ Right click on it and choose kind of **Open link in new tab**. Copy the URL and paste it were you need it. -## Screenshot modification +## Screenshot Modification -### Add an arrow or some other marking stuff +### Add an Arrow or some other Marking Stuff {% tabs %} {% tab title="macOS" %} + #### In the Preview App Got to: **Menu** + **Tools** \(GER: Werkzeuge\) + **Annotate** \(GER: Anmerkungen\) + etc.