Commit e2de8827 authored by Thomas Citharel's avatar Thomas Citharel 🏃🏻
Browse files

Merge branch 'contribute-fixes' into 'master'

Small fixes to the Contribute section

See merge request !58
parents 8d841845 1a696a24
Pipeline #430895 passed with stage
in 40 seconds
......@@ -10,7 +10,7 @@ To match usernames to actors, Mobilizon uses [WebFinger](https://tools.ietf.org/
## Instance subscriptions
Instances subscribe to each other through an internal actor named `relay@instance.tld` that publishes (through `Announce`) every created content to it's followers. Each content creation share is saved so that updates and deletes are correctly sent to every relay subscriber.
Instances subscribe to each other through an internal actor named `relay@instance.tld` that publishes (through `Announce`) every item of created content to it's followers. Each content creation share is saved so that updates and deletes are correctly sent to every relay subscriber.
## Activities
......@@ -221,7 +221,7 @@ We use Schema.org's [`maximumAttendeeCapacity`](https://schema.org/maximumAttend
#### anonymousParticipationEnabled
We add this boolean field to know whether or not anonymous participants can participate to an event.
We add this boolean field to know whether or not anonymous participants can participate in an event.
!!! note
Even though this information is federated, we redirect anonymous participants to the original instance so they can participate.
......@@ -248,4 +248,4 @@ We add a `participationMessage` property on a `Join` activity so that participan
}
]
}
```
\ No newline at end of file
```
# GraphQL API
Mobilizon features a [GraphQL API](https://graphql.org). Authentification is handled with [Json Web Tokens](https://jwt.io). Each instance provides a GraphQL playground at `/graphiql`, such as https://mobilizon.fr/graphiql that you can use to explore the schema. You can also use [the schema's representation](https://framagit.org/framasoft/mobilizon/-/blob/master/js/schema.graphql).
Mobilizon features a [GraphQL API](https://graphql.org). Authentication is handled with [Json Web Tokens](https://jwt.io). Each instance provides a GraphQL playground at `/graphiql`, such as https://mobilizon.fr/graphiql that you can use to explore the schema. You can also use [the schema's representation](https://framagit.org/framasoft/mobilizon/-/blob/master/js/schema.graphql).
Each instance's endpoint is at `/api`.
......@@ -101,4 +101,4 @@ mutation createEvent(
draft
}
}
```
\ No newline at end of file
```
......@@ -26,7 +26,7 @@ If you haven't noticed yet, French is sometimes used as a language for communica
We don't want to impose French as the only language in the project, though, because we would lose a ton of potential users and contributors that can help us make Mobilizon better.
You can write what you would like to tell us in the language you're most comfortable with and then use automagic translation to translate your message in English. It's far from perfect, but if we can understand the main idea you wanted to expose, it's sufficient.
You can write what you would like to tell us in the language you're most comfortable with and then use automagic translation to translate your message to English. It's far from perfect, but if we can understand the main idea you wanted to expose, it's sufficient.
Of course, you can and should express yourself directly in English if you're confident doing so!
......@@ -48,7 +48,7 @@ We require all participants to read and accept our [Code of Conduct](code_of_con
### Submitting Feature Requests, Enhancement Suggestions or Bug Reports
This section guides you through submitting a ✨ feature request, 💄 enhancement suggestions, and 🐛 bug reports for Mobilizon - anything from errors and crashes, to minor improvements, to completely new features.
This section guides you through submitting ✨ feature requests, 💄 enhancement suggestions, and 🐛 bug reports for Mobilizon - anything from errors and crashes, to minor improvements, to completely new features.
When you post an issue, please include as many details as possible. **Fill in the issue template** (available below) to help us resolve issues faster.
......@@ -65,13 +65,13 @@ Please go through the checklist below before posting any ✨ 💄 🐛
### Suggesting Features & Enhancements
If you find yourself wishing for a feature that doesn't exist in Mobilizon, you are probably not alone. There are probably others out there with similar needs.
If you find yourself wishing for a feature that doesn't exist in Mobilizon, you are probably not alone. There are likely others out there with similar needs.
Open an issue providing the following information:
* **Use a clear and descriptive title** for the issue to identify the suggestion.
* **Provide a description of the suggested enhancement** in as many details as possible, including the steps that you imagine you (as a user) would take if the feature you're requesting existed.
* **Describe the current behaviour** and **explain which behaviour you would like to see instead** and why.
* **Provide a description of the suggested enhancement** with as many details as possible, including the steps that you imagine you (as a user) would take if the feature you're requesting existed.
* **Describe the current behaviour** and **explain which behaviour you would like to see instead**, and why.
* **Include screenshots and animated GIFs** which help demonstrate the steps or point out the parts of Mobilizon which your suggestion is related to. You can use a tool called [LICEcap](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [Silentcast](https://github.com/colinkeenan/silentcast) or [Byzanz](https://github.com/GNOME/byzanz) on Linux.
* **Provide specific examples to demonstrate the enhancements**. If possible, include drawings, screenshots, or GIFs of similar features in another app.
* **Explain why this enhancement would be useful** to most participants of Mobilizon and isn't something that can or should be implemented as a community extension.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment