-
Notifications
You must be signed in to change notification settings - Fork 908
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: Add breaking datasource identification changes #5171
docs: Add breaking datasource identification changes #5171
Conversation
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.
Can we put 24.1 at the top, so the read order is most recent version first since that is how the larger page organization goes?
I think that depends if we want to prioritize consistency or readability. The later changes are a direct result of the one before it, so I think it's harder understanding why the changes happened when we put them in reverse chronological order. If you don't see it is a big hindrance, I'm fine reordering them. |
Good point. Maybe have the header title include the affected versions, e.g. Another option is to reorganize the page to run oldest to newest. |
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.
Thanks for the content @TheRealFalcon. It mostly looks good. I have a couple of minor change requests in line.
not available. | ||
**24.1** | ||
ds-identify will no longer automatically append ``None`` to a | ||
datasource list that has been provided under ``/etc/cloud``. If ``None`` |
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.
This only holds true when the datasource_list that is provided under /etc/cloud/
has a length of 1, right? Can we please clarify that?
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.
nit: also this subsection is declarative while the others are imperative which feels awkward "will no longer" vs "no longer"
many operating system vendors patch out breaking changes in | ||
cloud-init to ensure consistent behavior on their platform. | ||
|
||
Datasource identification |
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.
Grouping these is useful, but it doesn't fit with the existing content since the header Datasource identification
isn't ordered while the existing content is. Perhaps something like @catmsred's suggestion 23.2-24.1 Datasource identification
would resolve that?
Updated based on comments. Let me know if this new heading looks any better. |
I'm fine with it. @catmsred? |
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.
Thanks again @TheRealFalcon!
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.
Looks good to me!
Proposed Commit Message
Merge type