docs: Improves README and documentation#227
Conversation
frgfm
added
topic: docs
Codecov Report
@@ Coverage Diff @@
## master #227 +/- ##
=======================================
Coverage 94.08% 94.09%
=======================================
Files 47 47
Lines 1285 1286 +1
=======================================
+ Hits 1209 1210 +1
Misses 76 76
Flags with carried forward coverage won't be shown. Click here to find out more.
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
fe51
left a comment
fe51
left a comment
There was a problem hiding this comment.
Hi FG !
Thanks a lot for the PR, it makes this repo usage clearer ! few questions but not blocking :)
| make test | ||
| ``` | ||
|
|
||
| This will run the full suite of core API unittests. However, if you're trying to run some specific unittests, you can do as follows: |
There was a problem hiding this comment.
Maybe we should specify that these tests only concern the api and not the client. The current wording suggests that the command will test everything, whereas there is a specific command for the client. Maybe specify the client test command (while specifying that the current test coverage is not complete yet) ?
There was a problem hiding this comment.
I thought "core API" was specific enough 😅
| With the previously described tables, here are all the steps to send a wildfire alert: | ||
| - Prerequisites (ask the instance administrator): register user | ||
| - Register a device: declare your device on the API, using your new user credentials. | ||
| - Create a media object & upload content: using the device credentials, save the picture metadata and upload the image content. |
There was a problem hiding this comment.
Do you think it would be needed to explain that there is service to store images (s3 alike) and other tables are in an postgres table ?
There was a problem hiding this comment.
This is explained in CONTRIBUTING (I think we should scare people only coming for usage / light development rather than "hardcore" developers)
| ``` | ||
|
|
||
| ## Usage | ||
| ### How is the database organized |
There was a problem hiding this comment.
Do you think an ER diagram would be needed ?
There was a problem hiding this comment.
Why not, but I would argue not in the README 😅 That will scare people haha
2 participants
This PR introduces the following modifications:
SERVER_NAMEintoSENTRY_SERVER_NAMEAny feedback is welcome!