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

docs: enforce/normalize v1 format on all te2mqtt code blocks #2408

Merged

Conversation

reubenmiller
Copy link
Contributor

Proposed changes

Enforce the display of the new MQTT v1 format in all te2mqtt code blocks, as currently the 0.13.0 docs still show the legacy MQTT api when the formats= is missing on the directive.

The global default needs to be kept at legacy so it does not break the older doc implementation, or at least until the setting can be made to auto detect which version is being shown.

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Improvement (general improvements like code refactoring that doesn't explicitly fix a bug or add any new functionality)
  • Documentation Update (if none of the other choices apply)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Paste Link to the issue


Checklist

  • I have read the CONTRIBUTING doc
  • I have signed the CLA (in all commits with git commit -s)
  • I ran cargo fmt as mentioned in CODING_GUIDELINES
  • I used cargo clippy as mentioned in CODING_GUIDELINES
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

Further comments

The global default needs to be kept at legacy so it does not break the older doc implementation, or at least until the setting can be made to auto detect which version is being shown.

Signed-off-by: Reuben Miller <reuben.d.miller@gmail.com>
@reubenmiller reubenmiller added the documentation Improvements or additions to documentation label Nov 3, 2023
@didier-wenzek didier-wenzek self-requested a review November 3, 2023 09:55
Copy link
Contributor

@didier-wenzek didier-wenzek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved

Copy link
Contributor

github-actions bot commented Nov 3, 2023

Robot Results

✅ Passed ❌ Failed ⏭️ Skipped Total Pass % ⏱️ Duration
356 0 3 356 100 1h3m22.607999999s

@reubenmiller reubenmiller merged commit 5dcb430 into thin-edge:main Nov 3, 2023
16 checks passed
@reubenmiller reubenmiller deleted the docs-enforce-te2mqtt-v1-format branch November 3, 2023 10:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants