ocelot-Social-Community/Ocelot-Social
1
0
Fork 0
mirror of https://github.com/Ocelot-Social-Community/Ocelot-Social.git synced 2025-12-12 23:35:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix typo

Browse Source
This commit is contained in:
mahula 2023-11-21 11:52:08 +01:00
parent 9055ceab40
commit da9fb19fc7
5 changed files with 25 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.github/workflows/mlc_config.json vendored
View File

@ -3,7 +3,7 @@
"retryOn429": true, "retryOn429": true,
"retryCount": 2, "retryCount": 2,
"fallbackRetryDelay": "30s", "fallbackRetryDelay": "30s",
"aliveStatusCodes": [200, 206, 403], "aliveStatusCodes": [200, 206, 303, 403],
"ignorePatterns": [ "ignorePatterns": [
{ {
"pattern": "^(https:\/\/github.com\/Ocelot-Social-Community\/Ocelot-Social\/pull\/|http:\/\/localhost)" "pattern": "^(https:\/\/github.com\/Ocelot-Social-Community\/Ocelot-Social\/pull\/|http:\/\/localhost)"

4
.vuepress/config/meta.js
View File

@ -1,7 +1,7 @@
export default { export default {
base: '/', base: '/',
title: 'Ocelot-Social Documentation', title: 'Ocelot.Social Documentation',
description: 'Ocelot-Social Documentation', description: 'Ocelot.Social Documentation',
head: [ head: [
['meta', {name: 'viewport', content: 'width=device-width,initial-scale=1'}], ['meta', {name: 'viewport', content: 'width=device-width,initial-scale=1'}],
], ],

2
SUMMARY.md
View File

@ -1,7 +1,6 @@
# Table of contents # Table of contents
* [Introduction](README.md) * [Introduction](README.md)
* [Edit this Documentation](edit-this-documentation.md)
* [Neo4J](neo4j/README.md) * [Neo4J](neo4j/README.md)
* [Backend](backend/README.md) * [Backend](backend/README.md)
* [GraphQL](backend/graphql.md) * [GraphQL](backend/graphql.md)
@ -19,4 +18,5 @@
* [Contributing](CONTRIBUTING.md) * [Contributing](CONTRIBUTING.md)
* [Feature Specification](cypress/features.md) * [Feature Specification](cypress/features.md)
* [Code of Conduct](CODE_OF_CONDUCT.md) * [Code of Conduct](CODE_OF_CONDUCT.md)
* [Documentation](documentation.md)
* [License](LICENSE.md) * [License](LICENSE.md)

4
deployment/DOCKER_MORE_CLOSELY.md
View File

@ -27,7 +27,3 @@ $ docker compose -f docker-compose.ocelotsocial-branded.yml -f docker-compose.ap
# only once: init admin user and create indexes and constraints in Neo4j database # only once: init admin user and create indexes and constraints in Neo4j database
$ docker compose exec backend /bin/sh -c "yarn prod:migrate init" $ docker compose exec backend /bin/sh -c "yarn prod:migrate init"
``` ```
## Docker More Closely In Main Code
To get more informations about the Apple M1 platform and to analyze the Docker builds etc. you find our documentation in our main code, [here](https://github.com/Ocelot-Social-Community/Ocelot-Social/blob/master/DOCKER_MORE_CLOSELY.md).

36
edit-this-documentation.md → documentation.md
View File

@ -1,4 +1,6 @@
# Edit this Documentation # Documentation
## Edit this Documentation
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. 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.
@ -10,15 +12,15 @@ If you are ready, fill in the **Propose file change** at the end of the webpage.
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.) 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 ### Markdown your documentation
To design your documentation see the syntax description at GitBook: To design your documentation see the syntax description at GitBook:
[https://toolchain.gitbook.com/syntax/markdown.html](https://toolchain.gitbook.com/syntax/markdown.html) [https://toolchain.gitbook.com/syntax/markdown.html](https://toolchain.gitbook.com/syntax/markdown.html)
### Some quick Examples #### Some quick Examples
#### Headlines ##### Headlines
```markdown ```markdown
# Main Headline # Main Headline
@ -26,7 +28,7 @@ To design your documentation see the syntax description at GitBook:
### Small Headlines ### Small Headlines
``` ```
#### Tabs ##### Tabs
```markdown ```markdown
::: tabs ::: tabs
@ -38,7 +40,7 @@ To design your documentation see the syntax description at GitBook:
``` ```
#### Commands ##### Commands
~~~markdown ~~~markdown
```<LANGUAGE> (for text highlighting) ```<LANGUAGE> (for text highlighting)
@ -46,33 +48,33 @@ XXX
``` ```
~~~ ~~~
#### Links ##### Links
```markdown ```markdown
[XXX](https://XXX) [XXX](https://XXX)
``` ```
#### Screenshots or other Images ##### Screenshots or other Images
```markdown ```markdown
![XXX](https://XXX) ![XXX](https://XXX)
``` ```
#### Hints for ToDos ##### Hints for ToDos
```markdown ```markdown
{% hint style="info" %} TODO: XXX {% endhint %} {% 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" %} {% hint style="info" %}
TODO: How to host on Ocelot-Social \(GitHub\) repository ... TODO: How to host on Ocelot-Social \(GitHub\) repository ...
{% endhint %} {% endhint %}
### Quick Solution #### Quick Solution
To quickly host the screenshots go to: To quickly host the screenshots go to:
@ -86,14 +88,14 @@ Right click on it and choose kind of **Open link in new tab**.
Copy the URL and paste it were you need it. 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 ::: tabs
@tab:active 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.
@ -109,3 +111,7 @@ TODO: How to modify screenshots in Windows ...
TODO: How to modify screenshots in Linux ... TODO: How to modify screenshots in Linux ...
{% endhint %} {% endhint %}
::: :::
## Deploy this Documentation
TODO