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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename "p-label" to "p-status-label" #4400

Merged
merged 11 commits into from
Apr 12, 2022
Merged

Conversation

andesol
Copy link
Contributor

@andesol andesol commented Apr 11, 2022

Done

  • Create a new component: p-status-label and add it to the examples section
  • Rename "Label" references to "Status label"

(I'm happy to use the deprecate mixin but I couldn't find an example)

Fixes #4395

QA

  • Open demo
  • Go to /docs/examples and check there are both a "label" and a "status label" components (and both work)
  • Review updated documentation:
    • "Label" should not appear in the side nav
    • Instead, there should be a "Status labels" pattern

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.

@webteam-app
Copy link

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

@andesol andesol changed the title Rename p-label to p-status-label Rename "p-label" to "p-status-label" Apr 11, 2022
@@ -74,7 +74,6 @@
{{ side_nav_item("/docs/patterns/heading-icon", "Heading icon") }}
{{ side_nav_item("/docs/patterns/icons", "Icons") }}
{{ side_nav_item("/docs/patterns/images", "Images") }}
{{ side_nav_item("/docs/patterns/labels", "Labels") }}
Copy link
Contributor

Choose a reason for hiding this comment

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

We remove this page, so the contents (labels.md) file should be removed as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@bartaz
Copy link
Contributor

bartaz commented Apr 12, 2022

Couple small things to make the docs complete and ready for release:

  • version in package.json should be updated - we are adding new "feature" (new component class name) so this should be a minor bump (to 3.2.0)
  • we should add information about new and deprecated components to "What's new" page: https://vanilla-framework-4400.demos.haus/docs/whats-new
    • the current contents of the top table (3.1.0) should be moved down to "Previously in Vanilla"
    • 2 rows added to the top table: one for renamed "Status Label" and another for deprecated "Label"

andesol and others added 2 commits April 12, 2022 10:03
@andesol
Copy link
Contributor Author

andesol commented Apr 12, 2022

I think this is ready for a review!

Copy link
Contributor

@bethcollins92 bethcollins92 left a comment

Choose a reason for hiding this comment

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

LGTM with one tiny change 馃憦馃徏

templates/docs/patterns/status-labels.md Outdated Show resolved Hide resolved
Co-authored-by: Beth Collins <beth.collins@canonical.com>
@andesol andesol merged commit 6310830 into canonical:main Apr 12, 2022
@andesol andesol deleted the rename-p-label branch April 12, 2022 14:35
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.

Rename "p-label" to "p-status-label"
4 participants