-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: add doc to help contributor, part musician announces
- Loading branch information
Showing
6 changed files
with
56 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
# How to use the Musician Announce | ||
|
||
The announces are separated in 3 parts : the management, the search & the display of last announces in the homepage. | ||
|
||
## Announce management | ||
|
||
The user can manage it's own announces : list & create them. | ||
_Note: right now it not possible to edit or remove announce_ | ||
|
||
To access the list you have to be logged in. | ||
Then you click on your profile menu (top right) and then click on "Mes annonces" : | ||
|
||
![Access to the announces list](musician-announce/profile-announce-access.png) | ||
|
||
Once the there you will see a list of your announces : | ||
|
||
![The announces list](musician-announce/announce-list.png) | ||
|
||
|
||
From there you create a new one by clicking on "Ajouter une nouvelle annonce" | ||
This will open a modal that will guide you to create an announce. | ||
|
||
For this particular part here are the interesting endpoints : | ||
- `api_instruments_get_collection` to get the list of instruments | ||
- `api_styles_get_collection` to get the list of music styles | ||
- `api_musician_announces_post` to create a new announce | ||
- `api_musician_announces_get_self_collection` to get the user own announces | ||
|
||
## Last announces in the homepage | ||
|
||
Visitor can see last announce the other user have created. | ||
This part is available in the homepage : | ||
![Last announce](musician-announce/last-announce-homepage.png) | ||
|
||
You will note that there is buttons to create an announce (we have seen that in the previous point) and search for an announce. | ||
|
||
For this particular part here are the interesting endpoints : | ||
- `api_musician_announces_get_last_collection` to get the last added musician announces | ||
|
||
|
||
## Search | ||
|
||
Todo |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# How to use MusicAll | ||
|
||
This documentation will explain you how to use and where to search if you want to contribute to MusicAll. | ||
It will be split by "sections" related to the website. | ||
You should have MusicAll up and running as requirement (of course you can read this just for fun!) | ||
|
||
|
||
- [How to use the musician announce](howto-musician-announce.MD) | ||
|
||
|
||
_Note: this is an in progress doc, more to come_ |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.