Add device ownership configuration docs again #770
Merged
Conversation
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
|
@edibotopic Feel free to take over this PR and restructure, rephrase or rewrite as you see fit. |
adombeck
force-pushed
the
device-ownership-doc
branch
from
06ca4be to
739c5af
Compare
edibotopic
approved these changes
Jan 29, 2025
There was a problem hiding this comment.
This looks fine to me @adombeck .
I just have a minor change and a tiny query.
Approving in advance. If the docs are restructured in an upcoming pulse then the placement of this specific content can be reappraised as needed.
|
Reading this new section, it feels like it's only repeating what is already documented in the comments of the |
adombeck
force-pushed
the
device-ownership-doc
branch
from
a38a568 to
304e661
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The documentation of the device ownership configuration was revert in #704 because back then we didn't have a
latestversion of the docs, so the documentation was already live but the feature was not released yet, which led to confusion of users.I cherry-picked 4ed5bd4, but the "Broker configuration" section which that commit added the new documentation to doesn't exist anymore since 872c99a2797b0333cb228ef2316e3c69abfdd1c, so I added it to a new "Configure allowed users" section instead. 4ed5bd4 added the full content of the
broker.conffile to the "Broker configuration" section, which also included thehome_base_dirandssh_allowed_suffixesoptions along with their comments, so those were documented to some degree as a side effect. I did not add those to the new "Configure allowed users" section, so they are now still not documented.