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

[NUXE-47] Create samples categories #1214

Merged
merged 10 commits into from Nov 19, 2020
Merged

[NUXE-47] Create samples categories #1214

merged 10 commits into from Nov 19, 2020

Conversation

bh247484
Copy link
Contributor

@bh247484 bh247484 commented Nov 17, 2020

What does this PR do?

  1. Creates categories for samples. Hierarchy structured in samples.yml.
  2. Improves sample generator to accept --category flag. It updates the yaml and creates templated files/imports.
  3. Sample index is now rendered iteratively. It loops through the category titles and page entries in samples.yml and creates titles, list text, and images dynamically. New svg cards for each category can be added by placing an svg in the asset folder that matches the name of the yaml category, i.e. new_category.svg.
  4. TLDR All these improvements enable quick and easy sample category and sample page generation.

Addendum...
Fixes bug described in this story. Renames React component to line up with rendering helper string parse conventions and removes duplicate js import in samples layout.

Screens

gen_command
yaml
view

Breaking Changes

n/a

Runway Ticket URL

Link to Runway Story

How to test this

Try generating new sample, make sure it appears as expected on the page.

Checklist:

  • LABELS Add a label: enhancement, bug, improvement, new kit, deprecated, or breaking. See Changelog & Labels for details.
  • URGENCY Please select a release milestone
  • DEPLOY Please add the Milano label when you are ready for a review.
  • SCREENSHOT Please add a screen shot or two.
  • SPECS Please cover your changes with specs.
  • READ DOCS Please make sure you have read and understand the Playbook Release Process

The normal release cut off deadline is 3p EDT each week. Please reach out to the release team if you have an urgent request or need a release off cycle.

@bh247484 bh247484 added the improvement This is used when your PR contains library upgrades or doc/site improvements. (USED IN CHANGELOG)) label Nov 17, 2020
@bh247484 bh247484 added this to the 7.8.0 milestone Nov 17, 2020
@bh247484 bh247484 requested a review from a team as a code owner November 17, 2020 18:23
@bh247484 bh247484 self-assigned this Nov 17, 2020
@bh247484 bh247484 added the milano 20 MAX - Deploy this PR to a review environment via Milano label Nov 18, 2020
flex-direction: column;
align-items: center;
}
@include break_at(731px){
Copy link
Contributor

Choose a reason for hiding this comment

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

interesting px choice. Any particular reason for 731? Just curious!

Copy link
Contributor Author

@bh247484 bh247484 Nov 18, 2020

Choose a reason for hiding this comment

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

Right? That's the exact width at which stuff displays wonky if it's not vertically aligned (flex-direction: column). Had to reconfigure it after adding new min-width value to the list kit.

@bh247484 bh247484 changed the title Samples categories Created samples categories Nov 19, 2020
@bh247484 bh247484 changed the title Created samples categories Create samples categories Nov 19, 2020
@bh247484 bh247484 changed the title Create samples categories [NUXE-47] Create samples categories Nov 19, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants