-
Notifications
You must be signed in to change notification settings - Fork 7.5k
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
new release notes layout #15291
base: main
Are you sure you want to change the base?
new release notes layout #15291
Conversation
✅ Deploy Preview for docsdocker ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site settings. |
2698d56
to
9cc85d8
Compare
9cc85d8
to
df38cbb
Compare
@@ -0,0 +1,54 @@ | |||
.release-date { |
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 think there's work we could do in this file to keep things closer to the design system, but I think it's probably most efficient to let this in as it stands and then include it in a docs-wide theming review in the future.
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.
Awesome! Let me know if you need anything!
8d00b02
to
251be18
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 great to me, nice UI design, really nice that it uses yaml data, awesome work! 👍
Thanks @crazy-max. The badges look neat and helps users understand the type of fix. We have release notes for other components as well that follow a different format. We need to take a look at this a whole and see how we can be consistent across components. Before we go ahead and use this format, I'd like to review this with the team and get their input as well as it's not just Buildx docs but also affects other projects. |
e55c1ee
to
9efba94
Compare
9efba94
to
9654037
Compare
Made some changes to have a more generic release-notes layout so it can be used across our website:
I also split each release in its dedicated yaml definition. This way we could reuse this yaml file directly in Docker Desktop to display release notes for current version by just fetching it. Here is an example with Docker Desktop 4.12 and 4.11: https://deploy-preview-15291--docsdocker.netlify.app/desktop/release-notes/ |
749a340
to
1a8034d
Compare
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
1a8034d
to
711be54
Compare
Thanks for the pull request. We'd like to make our product docs better, but haven’t been able to review all the suggestions. If the updates are still relevant, review our contribution guidelines and rebase your pull request against the latest version of the docs, then mark it as fresh with a Prevent pull requests from auto-closing with a /lifecycle stale |
/lifecycle frozen |
Adds a new utility called
release-notes
that I find more appealing and declarative for the end user, starting with build one. This utility can be reused by other projects. we might need to tweak a bit some fields to make it more generic and cover all use cases (cc @thaJeztah @usha-mandya):Signed-off-by: CrazyMax crazy-max@users.noreply.github.com