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

new release notes layout #15291

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from
Draft

Conversation

crazy-max
Copy link
Member

@crazy-max crazy-max commented Aug 2, 2022

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):

image

Signed-off-by: CrazyMax crazy-max@users.noreply.github.com

@netlify
Copy link

netlify bot commented Aug 2, 2022

Deploy Preview for docsdocker ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 711be54
🔍 Latest deploy log https://app.netlify.com/sites/docsdocker/deploys/63205792e8957000084a9f18
😎 Deploy Preview https://deploy-preview-15291--docsdocker.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@crazy-max crazy-max force-pushed the buildx-release-notes branch 2 times, most recently from 2698d56 to 9cc85d8 Compare August 4, 2022 11:27
@crazy-max crazy-max changed the title build: builx release notes build: release notes Aug 4, 2022
@crazy-max crazy-max marked this pull request as ready for review August 4, 2022 11:32
@crazy-max crazy-max requested a review from dockertopia as a code owner August 4, 2022 11:32
@crazy-max crazy-max requested a review from mark-dr August 4, 2022 11:38
@crazy-max crazy-max force-pushed the buildx-release-notes branch from 9cc85d8 to df38cbb Compare August 4, 2022 11:43
@@ -0,0 +1,54 @@
.release-date {
Copy link
Contributor

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.

Copy link
Member Author

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!

@crazy-max crazy-max force-pushed the buildx-release-notes branch 2 times, most recently from 8d00b02 to 251be18 Compare August 4, 2022 12:56
mark-dr
mark-dr previously approved these changes Aug 4, 2022
Copy link
Contributor

@mark-dr mark-dr left a 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! 👍

@usha-mandya
Copy link
Member

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.

@crazy-max crazy-max added the area/build Relates to Dockerfiles or docker build command label Sep 10, 2022
@crazy-max crazy-max force-pushed the buildx-release-notes branch 2 times, most recently from e55c1ee to 9efba94 Compare September 11, 2022 00:52
@crazy-max crazy-max marked this pull request as draft September 11, 2022 10:36
@crazy-max crazy-max changed the title build: release notes new release notes layout Sep 12, 2022
@crazy-max crazy-max added the area/ux Issue affects functionality of docs.docker.com label Sep 12, 2022
@crazy-max
Copy link
Member Author

Made some changes to have a more generic release-notes layout so it can be used across our website:

  • We can define components with their respective entries like Docker Desktop release notes does (For all platforms, For Mac, ...).
  • Option to enable/disable GitHub link to full release notes
  • Multiple tags support and allow arbitrary ones
  • Header support to add arbitrary content before listing entries for each release
  • New upgrade and security tag

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/

image

@crazy-max crazy-max force-pushed the buildx-release-notes branch 2 times, most recently from 749a340 to 1a8034d Compare September 13, 2022 10:06
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>
@docker-robott
Copy link
Collaborator

Thanks for the pull request. We'd like to make our product docs better, but haven’t been able to review all the suggestions.
As our docs have also diverged, we do not have the bandwidth to review and rebase old pull requests.

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 /remove-lifecycle stale comment.
If not, this pull request will be closed in 30 days. This helps our maintainers focus on the active pull requests.

Prevent pull requests from auto-closing with a /lifecycle frozen comment.

/lifecycle stale

@crazy-max
Copy link
Member Author

/lifecycle frozen

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/build Relates to Dockerfiles or docker build command area/ux Issue affects functionality of docs.docker.com lifecycle/frozen lifecycle/stale
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants