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

[PLAY-1391] Add Category to Playbook kit generator #3488

Merged
merged 5 commits into from
Jul 5, 2024

Conversation

ElisaShapiro
Copy link
Contributor

@ElisaShapiro ElisaShapiro commented Jun 26, 2024

What does this PR do? A clear and concise description with your runway ticket url.
PLAY-1391 adds the capability to use a category flag when creating a new kit with the Playbook kit generator that allows for the newly generated kit to be sorted into one of the preexisting categories (aka submenus with in Components on the sidebar). This feature does not allow for the generation of new categories via this generator (creating new categories is a rare occurrence and should be done manually) and it is optional (when a kit is generated with a category flag, it will function like it is currently and just be appended to the bottom of the menu.yml).

This ticket is a follow up following an initial investigation done during PLAY-1330 which fixed the Fix generator and updated its documentation. New information about the Category prop will be added to the Generating a Kit huddle doc once this is approved (the draft is here with doc changes pending approval).

Screenshots: Screenshots to visualize your addition/change
Example Uno: adding a new kit with a typo in the category, then successfully doing so once fixed
uno codeuno page

Example dos: adding a new kit with a category and a kit type
dos codedos page

Example tres: adding a new kit without a category specified
tres codetres page

Example quatro: adding a new kit with kit type, props, and category specified
quatro codequatro page

How to test? Steps to confirm the desired behavior:

  1. Pull down this branch.
  2. Reference the generating a kit documentation to try to add a kit with a category (see draft linked above if huddle doc not yet updated).
  3. New kit should be added to menu.yml file and visible on the PB website locally when you start the server and check localhost.
  4. Try to add a kit omitting a category (and see it append to the bottom of menu.yml like it did previously; try to mess up the category name (with a typo or a category that doesn't exist) and see the generator stall out.

ALTERNATIVE:
Reference demo video in Runway ticket.

Checklist:

  • LABELS Add a label: enhancement, bug, improvement, new kit, deprecated, or breaking. See Changelog & Labels for details.
  • DEPLOY I have added the milano label to show I'm ready for a review.
    - [ ] TESTS I have added test coverage to my code.

@ElisaShapiro ElisaShapiro added the improvement This is used when your PR contains library upgrades or doc/site improvements. (USED IN CHANGELOG)) label Jun 26, 2024
@ElisaShapiro ElisaShapiro self-assigned this Jun 26, 2024
jasperfurniss
jasperfurniss previously approved these changes Jun 27, 2024
@ElisaShapiro ElisaShapiro added the milano 20 MAX - Deploy this PR to a review environment via Milano label Jun 28, 2024
@ElisaShapiro ElisaShapiro marked this pull request as ready for review June 28, 2024 18:00
@ElisaShapiro ElisaShapiro requested review from a team as code owners June 28, 2024 18:00
jasperfurniss
jasperfurniss previously approved these changes Jun 28, 2024
@nidaqg nidaqg added Product Approved pending technical review, OK to merge to master Code Approved Approved by a Playbook Admin labels Jul 3, 2024
nidaqg
nidaqg previously approved these changes Jul 3, 2024
@nidaqg nidaqg added this pull request to the merge queue Jul 5, 2024
Merged via the queue into master with commit 6168cf5 Jul 5, 2024
5 checks passed
@nidaqg nidaqg deleted the PLAY-1391-add-category-to-kit-generator branch July 5, 2024 16:05
github-merge-queue bot pushed a commit that referenced this pull request Jul 11, 2024
**What does this PR do?** A clear and concise description with your
runway ticket url.

Fixes kit status that accidentally got put bsck into beta on [this
PR](#3488)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Code Approved Approved by a Playbook Admin improvement This is used when your PR contains library upgrades or doc/site improvements. (USED IN CHANGELOG)) milano 20 MAX - Deploy this PR to a review environment via Milano Product Approved pending technical review, OK to merge to master
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants