-
Notifications
You must be signed in to change notification settings - Fork 669
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
NOISSUE - Update docs #683
Conversation
Signed-off-by: Dušan Borovčanin <dusan.borovcanin@mainflux.com>
Signed-off-by: Dušan Borovčanin <dusan.borovcanin@mainflux.com>
Codecov Report
@@ Coverage Diff @@
## master #683 +/- ##
==========================================
- Coverage 86.29% 86.24% -0.06%
==========================================
Files 62 62
Lines 3722 3722
==========================================
- Hits 3212 3210 -2
- Misses 353 355 +2
Partials 157 157
Continue to review full report at Codecov.
|
docs/authentication.md
Outdated
|
||
### MQTTS | ||
|
||
*PUBLISH* |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do not use SMALLCAPS, rather use sub-topic ####
.
docs/authentication.md
Outdated
```bash | ||
mosquitto_pub -u <thing_id> -P <thing_key> -t channels/<channel_id>/messages -h localhost --cafile docker/ssl/certs/ca.crt --cert docker/ssl/certs/<thing_cert_name>.crt --key docker/ssl/certs/<thing_cert_key>.key -m '[{"bn":"some-base-name:","bt":1.276020076001e+09, "bu":"A","bver":5, "n":"voltage","u":"V","v":120.1}, {"n":"current","t":-5,"v":1.2}, {"n":"current","t":-4,"v":1.3}]' | ||
``` | ||
*SUBSCRIBE* |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same here.
docs/authentication.md
Outdated
|
||
### MQTTS | ||
|
||
#### PUBLISH |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No need for SMALLCAPS here
docs/authentication.md
Outdated
mosquitto_pub -u <thing_id> -P <thing_key> -t channels/<channel_id>/messages -h localhost --cafile docker/ssl/certs/ca.crt --cert docker/ssl/certs/<thing_cert_name>.crt --key docker/ssl/certs/<thing_cert_key>.key -m '[{"bn":"some-base-name:","bt":1.276020076001e+09, "bu":"A","bver":5, "n":"voltage","u":"V","v":120.1}, {"n":"current","t":-5,"v":1.2}, {"n":"current","t":-4,"v":1.3}]' | ||
``` | ||
|
||
#### SUBSCRIBE |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same here
Signed-off-by: Dušan Borovčanin <dusan.borovcanin@mainflux.com>
Signed-off-by: Dušan Borovčanin <dusan.borovcanin@mainflux.com>
* Add authorization section to the docs Signed-off-by: Dušan Borovčanin <dusan.borovcanin@mainflux.com> * Slow down Bootstrap gif Signed-off-by: Dušan Borovčanin <dusan.borovcanin@mainflux.com> * Use heading 4 instead of italic Signed-off-by: Dušan Borovčanin <dusan.borovcanin@mainflux.com> * Replace gif with carousel Signed-off-by: Dušan Borovčanin <dusan.borovcanin@mainflux.com>
* Add authorization section to the docs Signed-off-by: Dušan Borovčanin <dusan.borovcanin@mainflux.com> * Slow down Bootstrap gif Signed-off-by: Dušan Borovčanin <dusan.borovcanin@mainflux.com> * Use heading 4 instead of italic Signed-off-by: Dušan Borovčanin <dusan.borovcanin@mainflux.com> * Replace gif with carousel Signed-off-by: Dušan Borovčanin <dusan.borovcanin@mainflux.com>
* Add authorization section to the docs Signed-off-by: Dušan Borovčanin <dusan.borovcanin@mainflux.com> * Slow down Bootstrap gif Signed-off-by: Dušan Borovčanin <dusan.borovcanin@mainflux.com> * Use heading 4 instead of italic Signed-off-by: Dušan Borovčanin <dusan.borovcanin@mainflux.com> * Replace gif with carousel Signed-off-by: Dušan Borovčanin <dusan.borovcanin@mainflux.com>
* Add authorization section to the docs Signed-off-by: Dušan Borovčanin <dusan.borovcanin@mainflux.com> * Slow down Bootstrap gif Signed-off-by: Dušan Borovčanin <dusan.borovcanin@mainflux.com> * Use heading 4 instead of italic Signed-off-by: Dušan Borovčanin <dusan.borovcanin@mainflux.com> * Replace gif with carousel Signed-off-by: Dušan Borovčanin <dusan.borovcanin@mainflux.com>
What does this do?
This pull request updates Mainflux docs. It adds a separate
Authentication
section and updates Bootstrap service docs.Which issue(s) does this PR fix/relate to?
None.
List any changes that modify/break current functionality
There are no such changes.
Have you included tests for your changes?
No, this is only docs update.
Did you document any new/modified functionality?
No, I've just reorganized and improved existing docs.