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: Add breaking datasource identification changes #5171

Merged
merged 3 commits into from
Apr 19, 2024

Conversation

TheRealFalcon
Copy link
Member

Proposed Commit Message

docs: Add breaking datasource identification changes

Merge type

  • Squash merge using "Proposed Commit Message"
  • Rebase and merge unique commits. Requires commit messages per-commit each referencing the pull request number (#<PR_NUM>)

Copy link
Collaborator

@catmsred catmsred left a 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?

@TheRealFalcon
Copy link
Member Author

Can we put 24.1 at the top

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.

@holmanb holmanb self-assigned this Apr 12, 2024
@catmsred
Copy link
Collaborator

Can we put 24.1 at the top

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. 23.2-24.1 Datasource identification and then leave the subheadings as is?

Another option is to reorganize the page to run oldest to newest.

Copy link
Member

@holmanb holmanb left a 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``
Copy link
Member

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?

Copy link
Member

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
Copy link
Member

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?

@TheRealFalcon
Copy link
Member Author

TheRealFalcon commented Apr 19, 2024

Updated based on comments. Let me know if this new heading looks any better.

@holmanb
Copy link
Member

holmanb commented Apr 19, 2024

Updated based on comments. Let me know if this new heading looks any better.

I'm fine with it. @catmsred?

Copy link
Member

@holmanb holmanb left a comment

Choose a reason for hiding this comment

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

Thanks again @TheRealFalcon!

Copy link
Collaborator

@catmsred catmsred left a 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!

@TheRealFalcon TheRealFalcon merged commit 47e9ad7 into canonical:main Apr 19, 2024
28 checks passed
@TheRealFalcon TheRealFalcon deleted the breaking-datasource-list branch April 19, 2024 14:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants