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

Document tiered list macro #5351

Conversation

pastelcyborg
Copy link
Contributor

@pastelcyborg pastelcyborg commented Sep 13, 2024

Done

  • Add docs for Tiered List macro, following the conventions established in Hero macro docs
  • Drive-by: minor formatting and copy changes to align docs between patterns

Fixes WD-14523

QA

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 release (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.

@webteam-app
Copy link

pastelcyborg and others added 10 commits September 19, 2024 14:31
* Add macro install instructions to docs pages (canonical#5330)

* Update building-vanilla.md

* Update pattern docs

* Roll back pattern docs

* Update building-vanilla.md

* Add macros directory to published files

* Rename hero macro

* Rename tiered list macro

* Update releases.yml

* End hero title and subtitle params with _text per new naming convention

* Add html block comments to hero macro

* Add hero macro docn

* Add Hero macro import instructions

* Add link to @pastelcyborg jinja macros installation guide

* Fix hero title_text being renamed from rebase

* Adjust jinja parameters column order

* lowercase param types

* adjust slots column ordering

* Adjust slots is required per code review

* Markup params table

* Markup slots table

* parameter & slot tables horizontally scroll rather than using mobile cards

* Param/slot table widths set by percentage

* More consistent whitespace control chars around jinja macro import

* Revise hero element/description table word choice around title/substitle/description

* comma-separated string with line breaks for hero layout type options

* Update is required column by @bartaz

Co-authored-by: Bartek Szopka <[email protected]>

* Code review suggestions from @bartaz

Co-authored-by: Bartek Szopka <[email protected]>

---------

Co-authored-by: pastelcyborg <[email protected]>
Co-authored-by: Bartek Szopka <[email protected]>
@pastelcyborg pastelcyborg merged commit 5e824ef into canonical:feature/expose-macros Sep 19, 2024
4 checks passed
@pastelcyborg pastelcyborg deleted the document-tiered-list-macro branch September 19, 2024 18:42
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.

3 participants