Skip to content
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

Improve Documentation #339

Merged
10 commits merged into from
Jun 2, 2023
Merged

Improve Documentation #339

10 commits merged into from
Jun 2, 2023

Conversation

ghost
Copy link

@ghost ghost commented May 12, 2023

https://hivemq.kanbanize.com/ctrl_board/22/cards/12393/details/

Refactor documentation
Move options to includes
Remove Synopsis
Improve broker test section
Improve HiveMQ section
Improve Swarm section

Refactor documentation
Move options to includes
Remove Synopsis
@ghost ghost self-assigned this May 12, 2023
@ghost ghost requested a review from gitseti as a code owner May 12, 2023 09:15
@cla-bot cla-bot bot added the cla-signed label May 12, 2023
- Align command usage overview
- Use include for shared command options
- Add, refactor menu links to align with command options

Fix description in shell subscribe command
Fix bug in logging options documentation
Fix bug in test command log option description
Rename DefaultOptions to HelpOptions
Add help options to shell switch command
Add --time as -t alias to shell list command as documented
Fix commands bash examples to use $ on commands with output and remove otherwise
Add commands section to hivemq
Move hivemq export to separate file
Fix titles
Fix publish options
Add authentication section
@ghost ghost mentioned this pull request May 23, 2023
@tlopesPT tlopesPT self-requested a review June 1, 2023 13:28
docs/_docs/configuration.md Outdated Show resolved Hide resolved
docs/_docs/configuration.md Outdated Show resolved Hide resolved
docs/_docs/configuration.md Outdated Show resolved Hide resolved
docs/_docs/configuration.md Show resolved Hide resolved
docs/_docs/logging.md Outdated Show resolved Hide resolved
docs/_docs/shell/switch.md Outdated Show resolved Hide resolved
docs/_docs/subscribe.md Outdated Show resolved Hide resolved
docs/_docs/subscribe.md Outdated Show resolved Hide resolved
docs/_docs/subscribe.md Outdated Show resolved Hide resolved
docs/_docs/subscribe/connect_options.md Outdated Show resolved Hide resolved
docs/_docs/swarm/run.md Outdated Show resolved Hide resolved
docs/_docs/swarm/run.md Outdated Show resolved Hide resolved
docs/_docs/test.md Outdated Show resolved Hide resolved
@ghost ghost merged commit e1fd0b3 into master Jun 2, 2023
@ghost ghost deleted the improvement/documentation branch June 2, 2023 21:23
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants