mirror of
https://github.com/Ocelot-Social-Community/Ocelot-Social.git
synced 2025-12-12 23:35:58 +00:00
fix typo
This commit is contained in:
mahula
parent
9055ceab40
commit
da9fb19fc7
2
.github/workflows/mlc_config.json
vendored
2
.github/workflows/mlc_config.json
vendored
@ -3,7 +3,7 @@
|
||||
"retryOn429": true,
|
||||
"retryCount": 2,
|
||||
"fallbackRetryDelay": "30s",
|
||||
"aliveStatusCodes": [200, 206, 403],
|
||||
"aliveStatusCodes": [200, 206, 303, 403],
|
||||
"ignorePatterns": [
|
||||
{
|
||||
"pattern": "^(https:\/\/github.com\/Ocelot-Social-Community\/Ocelot-Social\/pull\/|http:\/\/localhost)"
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
export default {
|
||||
base: '/',
|
||||
title: 'Ocelot-Social Documentation',
|
||||
description: 'Ocelot-Social Documentation',
|
||||
title: 'Ocelot.Social Documentation',
|
||||
description: 'Ocelot.Social Documentation',
|
||||
head: [
|
||||
['meta', {name: 'viewport', content: 'width=device-width,initial-scale=1'}],
|
||||
],
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
# Table of contents
|
||||
|
||||
* [Introduction](README.md)
|
||||
* [Edit this Documentation](edit-this-documentation.md)
|
||||
* [Neo4J](neo4j/README.md)
|
||||
* [Backend](backend/README.md)
|
||||
* [GraphQL](backend/graphql.md)
|
||||
@ -19,4 +18,5 @@
|
||||
* [Contributing](CONTRIBUTING.md)
|
||||
* [Feature Specification](cypress/features.md)
|
||||
* [Code of Conduct](CODE_OF_CONDUCT.md)
|
||||
* [Documentation](documentation.md)
|
||||
* [License](LICENSE.md)
|
||||
|
||||
@ -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
|
||||
$ 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).
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -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.)
|
||||
|
||||
## Markdown your documentation
|
||||
### Markdown your documentation
|
||||
|
||||
To design your documentation see the syntax description at GitBook:
|
||||
|
||||
[https://toolchain.gitbook.com/syntax/markdown.html](https://toolchain.gitbook.com/syntax/markdown.html)
|
||||
|
||||
### Some quick Examples
|
||||
#### Some quick Examples
|
||||
|
||||
#### Headlines
|
||||
##### Headlines
|
||||
|
||||
```markdown
|
||||
# Main Headline
|
||||
@ -26,7 +28,7 @@ To design your documentation see the syntax description at GitBook:
|
||||
### Small Headlines
|
||||
```
|
||||
|
||||
#### Tabs
|
||||
##### Tabs
|
||||
|
||||
```markdown
|
||||
::: tabs
|
||||
@ -38,7 +40,7 @@ To design your documentation see the syntax description at GitBook:
|
||||
```
|
||||
|
||||
|
||||
#### Commands
|
||||
##### Commands
|
||||
|
||||
~~~markdown
|
||||
```<LANGUAGE> (for text highlighting)
|
||||
@ -46,33 +48,33 @@ XXX
|
||||
```
|
||||
~~~
|
||||
|
||||
#### Links
|
||||
##### Links
|
||||
|
||||
```markdown
|
||||
[XXX](https://XXX)
|
||||
```
|
||||
|
||||
#### Screenshots or other Images
|
||||
##### Screenshots or other Images
|
||||
|
||||
```markdown
|
||||
|
||||
```
|
||||
|
||||
#### 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 ...
|
||||
{% endhint %}
|
||||
|
||||
### Quick Solution
|
||||
#### Quick Solution
|
||||
|
||||
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.
|
||||
|
||||
## Screenshot Modification
|
||||
### Screenshot Modification
|
||||
|
||||
### Add an Arrow or some other Marking Stuff
|
||||
#### Add an Arrow or some other Marking Stuff
|
||||
|
||||
::: tabs
|
||||
@tab:active macOS
|
||||
|
||||
#### In the Preview App
|
||||
##### In the Preview App
|
||||
|
||||
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 ...
|
||||
{% endhint %}
|
||||
:::
|
||||
|
||||
## Deploy this Documentation
|
||||
|
||||
TODO
|
||||
Loading…
x
Reference in New Issue
Block a user