-
Notifications
You must be signed in to change notification settings - Fork 91
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
Add initial Katello 4.4.0 changelog entries #1056
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.
I see [SAT-xxx]
in various places. Is that really a good idea?
* Use the APT verbatim publisher for deb content on Pulp 3 foreman-proxy syncs ([#34279](https://projects.theforeman.org/issues/34279), [4a363fd9](https://github.com/Katello/katello.git/commit/4a363fd945d56ad48f6a30446d9c16320819d4a5)) | ||
|
||
=== Hosts | ||
* Hosts - Change content source ([#34211](https://projects.theforeman.org/issues/34211), [c5f8e953](https://github.com/Katello/katello.git/commit/c5f8e9532e61f9e5c7ec648decf81660628dd4ba)) |
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.
These look like markdown style links but asciidoc has a slightly different style.
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.
I uploaded a change that sticks to the original ./tools.rb changelog
style but should be good for asiidoc instead.
I'll need to clean those out, didn't realize the redmine issues had JIRA references... |
I suspected people clone BZs with that reference, but that's not the case: https://projects.theforeman.org/issues/33083 has no reference to BZ. If there is a desire to link to JIRA, we can introduce a custom field just like we did with Bugzilla but adding them in titles is not the right way. I've now added a custom field to the Katello project just to see if we can, but we should evaluate this in a larger context. |
|
||
A full list of changes is available via https://projects.theforeman.org/projects/katello/issues?utf8=%E2%9C%93&set_filter=1&sort=id%3Adesc%2C%2C&f%5B%5D=cf_12&op%5Bcf_12%5D=%3D&v%5Bcf_12%5D%5B%5D=1517&f%5B%5D=&c%5B%5D=tracker&c%5B%5D=status&c%5B%5D=priority&c%5B%5D=subject&c%5B%5D=author&c%5B%5D=assigned_to&c%5B%5D=updated_on&c%5B%5D=category&c%5B%5D=fixed_version&group_by=[Redmine] | ||
|
||
= Katello 4.4.0 Habanero (2022-02-11) |
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.
The release notes really should be something more curated rather than snippets from the CHANGELOG. The main reason being that the names of these things have no meaning to the user. And the average user isn't likely to be interested in the associated redmine and github information. IMO it's better to have a list of 5 meaningful things that a user can look to and say "yeah, that's a good reason to upgrade!" than 25 items that are virtually undecipherable. I know you were probably following whatever the last release engineer did, so I can't fault you there ;)
For my team, here are some notes (it's rough, feel free to adjust wording..)
- New interface available for syncing content between two Foreman servers. Available under the CDN Configuration tab in Content -> Subscriptions -> Manage Manifest.
- Red Hat repositories page no longer contacts the CDN when in Airgapped mode
- Numerous additions to the new host details UI including Installable Errata, Package filtering
- Numerous improvements to Content View exporting and importing
- Fixed errata installation raising errors when using Remote Execution
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.
The release notes really should be something more curated rather than snippets from the CHANGELOG. The main reason being that the names of these things have no meaning to the user. And the average user isn't likely to be interested in the associated redmine and github information. IMO it's better to have a list of 5 meaningful things that a user can look to and say "yeah, that's a good reason to upgrade!" than 25 items that are virtually undecipherable. I know you were probably following whatever the last release engineer did, so I can't fault you there ;)
We have headline features for that. With Foreman we've always published headline features (which are for an entire x.y series) but also a detailed list of issues for every .z within that series. That's why I structured the documents as a katello.adoc
and a katello-x.y.z.adoc
.
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.
Oh, I should also mention that https://docs.theforeman.org/3.1/Release_notes/index-katello.html is what I'm talking about. You can see that first it also includes all of Foreman so users no longer need to read both guides. Also note that the releases are in chronological order.
It's not really complete, as you can see that this part is empty.
407683e
to
66e2c7b
Compare
@jeremylenz and @jturel I tried to morph your ideas together, let me know what you think. |
👍 👍 |
That check failure seems unrelated to my PR. |
I think this is good to merge? |
I think #1081 should fix the link checker. I'd prefer to rebase on that to see if the build would be green. |
That was merged. Would you mind rebasing? |
66e2c7b
to
f710f77
Compare
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 like a good start and we can iterate on it later. I'd like to standardize the formatting between Foreman and Katello (Foreman doesn't differentiate between bugs and features), but we can work on that in the future.
The changelog will be updated after the first RC and so on.