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

Make updating the what's new page easier #4679

Conversation

abhigyanghosh30
Copy link
Contributor

@abhigyanghosh30 abhigyanghosh30 commented Mar 2, 2023

Done

Created a releases.yml file which contains information about all the releases and their important features

Fixes #4666

QA

  • Open demo
  • [Add QA steps]
  • Review updated documentation:
    • [List any updated documentation for review]

Check if PR is ready for release

If this PR contains Vanilla SCSS code changes, it should contain the following changes to make sure it's ready for the release:

  • PR should have one of the following labels to automatically categorise it in release notes:
    • Feature 🎁, Breaking Change 💣, Bug 🐛, Documentation 📝, Maintenance 🔨.
  • Vanilla version in package.json should be updated relative to the most recent release, following semver convention:
    • if CSS class names are not changed it can be bugfix relesase (x.x.X)
    • if CSS class names are changed/added/removed it should be minor version (x.X.0)
    • see the wiki for more details
  • Any changes to component class names (new patterns, variants, removed or added features) should be listed on the what's new page.
  • Documentation side navigation should be updated with the relevant labels.

Screenshots

[if relevant, include a screenshot or screen capture]

@webteam-app
Copy link

Demo starting at https://vanilla-framework-4679.demos.haus

Copy link
Contributor

@ClementChaumel ClementChaumel left a comment

Choose a reason for hiding this comment

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

It's already looking good! The side navigation matching is a bit off but the what's new page looks good!

templates/_layouts/docs.html Outdated Show resolved Hide resolved
templates/_layouts/docs.html Show resolved Hide resolved
templates/docs/whats-new.html Outdated Show resolved Hide resolved
templates/docs/whats-new.html Outdated Show resolved Hide resolved
templates/docs/whats-new.html Outdated Show resolved Hide resolved
templates/docs/whats-new.html Outdated Show resolved Hide resolved
templates/docs/whats-new.html Outdated Show resolved Hide resolved
webapp/app.py Outdated Show resolved Hide resolved
templates/_layouts/docs.html Show resolved Hide resolved
@ClementChaumel
Copy link
Contributor

It's already looking good! The side navigation matching is a bit off but the what's new page looks good!

Here's what I mean

image

image

BTW on that last one @bartaz which tag do you reckon we should show?

@bartaz
Copy link
Contributor

bartaz commented Mar 2, 2023

BTW on that last one @bartaz which tag do you reckon we should show?

We talked about it on standup, let's use the first/top one. And in YAML we just need to keep the order in place. But that's usually how it has been: whatever is updated on top, whatever is deprecated next.

Copy link
Contributor

@ClementChaumel ClementChaumel left a comment

Choose a reason for hiding this comment

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

As it stands it looks good to me! Appears to do what we wanted it to!

templates/docs/whats-new.html Outdated Show resolved Hide resolved
webapp/app.py Outdated


template_finder_view = TemplateFinder.as_view("template_finder")


@app.route("/whats-new")
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this new route needed?

It seems it works fine as it is, under /docs/what-new

Copy link
Contributor Author

Choose a reason for hiding this comment

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

oh right! I thought it was under /whats-new instead of /docs/whats-new

Copy link
Contributor

@bartaz bartaz left a comment

Choose a reason for hiding this comment

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

LGTM! Great work, it will be very useful!

@bartaz bartaz changed the title Wd 2281 make updating the what s new page easier Make updating the what's new page easier Mar 6, 2023
@bartaz bartaz merged commit 0a96615 into canonical:main Mar 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Make updating the "What's new" page easier
4 participants