mirror of
https://github.com/Ocelot-Social-Community/Ocelot-Social.git
synced 2025-12-12 23:35:58 +00:00
Fix divers links etc. in diverse readmes
This commit is contained in:
parent
33fbafd5cb
commit
64f276e56c
@ -6,7 +6,7 @@
|
||||
[](https://discord.gg/AJSX9DCSUA)
|
||||
[](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.
|
||||
|
||||
<!-- markdownlint-disable MD033 -->
|
||||
<p align="center">
|
||||
@ -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`.
|
||||
|
||||
|
||||
12
SUMMARY.md
12
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)
|
||||
|
||||
|
||||
@ -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.
|
||||
|
||||

|
||||
We have a closer description for the [GraphQL Playground](./src/graphql/GraphQL-Playground.md).
|
||||
|
||||

|
||||
|
||||
## Middleware keeps resolvers clean
|
||||
|
||||

|
||||
|
||||

|
||||
|
||||
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.
|
||||
|
||||
|
||||
@ -1,5 +1,7 @@
|
||||
# GraphQL Playground
|
||||
|
||||

|
||||
|
||||
***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:
|
||||
|
||||
@ -1,2 +1,3 @@
|
||||
# Unit Testing
|
||||
|
||||
***TODO:** To be filled in*
|
||||
|
||||
@ -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
|
||||

|
||||
```
|
||||
|
||||
#### 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.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user