Add macro install instructions to docs pages #5330

pastelcyborg · 2024-08-28T18:40:36Z

Done

Add macro install instructions to Building with Vanilla page
Add macro import instructions to pattern pages

QA

Open the following pages:
Confirm documentation is logical and functions as expected

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 · 2024-08-28T18:40:40Z

Demo

Jenkins

demos.haus

templates/docs/building-vanilla.md

templates/docs/patterns/hero/index.md

templates/docs/patterns/tiered-list/index.md

* Update building-vanilla.md * Update pattern docs * Roll back pattern docs * Update building-vanilla.md

@pastelcyborg

* Add macro install instructions to docs pages (#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]>

* Update building-vanilla.md * Update pattern docs * Roll back pattern docs * Update building-vanilla.md

@pastelcyborg

* Add macro install instructions to docs pages (#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

* 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

* Add macro install instructions to docs pages (#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]>

* Update building-vanilla.md * Update pattern docs * Roll back pattern docs * Update building-vanilla.md

@pastelcyborg

* Add macro install instructions to docs pages (#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

* Add macro install instructions to docs pages (#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]>

* Update building-vanilla.md * Update pattern docs * Roll back pattern docs * Update building-vanilla.md

@pastelcyborg

* Add macro install instructions to docs pages (#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

* Add macro install instructions to docs pages (#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]>

* Update building-vanilla.md * Update pattern docs * Roll back pattern docs * Update building-vanilla.md

@pastelcyborg

* Add macro install instructions to docs pages (#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

* Add macro install instructions to docs pages (#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

* Add macro install instructions to docs pages (#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 * Document hero macro (#5325) * Add macro install instructions to docs pages (#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]> * Rename hero macro * Document hero macro (#5325) * Add macro install instructions to docs pages (#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]> * Update _index.scss * Update _index.scss * Add tiered list docs; minor formatting updates * File formatting fixes * Change "call to action block" to "CTA block" * Add cta block slot docs * Add code comments * Apply static widths to table columns * Add route for serving raw example template * Render flask template in HTML code snippet * Show rendered/raw example * Enable switching between Jinja code snippets and rendered HTML * Slight example.js docs improvements & refactors * Run prettier * RM example guide * Switch jinja example trigger from .js-show-template to [data-lang='jinja'] * Use raw query parameter instead of `/example` path * Syntax-highlight HTML within Jinja template macro calls * Optional chain to avoid possible null index error * Make HTML the default example language, instead of Jinja * Simplify example xmlhttprequest check * Change initializer keywords to `let` or `const` * Move throttle() to a utils function * fix HTML snippets including JS at the bottom * Revert "Move throttle() to a utils function" This reverts commit 75e51b8. * rename `createPreCode` param `hide` to `isHidden` * Reapply "Move throttle() to a utils function" This reverts commit 99b32c9. * swap xmlhttprequest for fetch() * Moved fetch code from example file into shared utils * Move utils to window scope, rather than JS import * prettier * set no-cache on raw template endpoint * Re-remove extracted utils functions * replace `let` with `const` where applicable * Additional try/catch handler in `fetchResponse()` * renderdropdown guard * promise.all parallelization improvement * rename `EXAMPLE_OPTION_CFG` to `EXAMPLE_LANGUAGE_OPTION_CONFIG` * Move HTML body extraction functions into `fetchHtmlSource()` and return them there instead of generating them in the callback * rename `fetchHtmlSource()` to `fetchRenderedHtml()` * Switch default example language from HTML to jinja if jinja is found * Clean up parallelization per code review * Prepare macros for release (bump to 4.17.0) * Move jinja macro API docs to bottom of hero/tiered list pages * Remove markup comments from hero macro output --------- Co-authored-by: pastelcyborg <[email protected]> Co-authored-by: Bartek Szopka <[email protected]>

pastelcyborg added 2 commits August 28, 2024 14:32

Update building-vanilla.md

406affc

Update pattern docs

f09ada2

pastelcyborg requested review from bartaz, jmuzina and advl August 28, 2024 18:46

pastelcyborg added Review: QA needed Review: Code needed Documentation 📝 Documentation changes or updates labels Aug 28, 2024

pastelcyborg marked this pull request as ready for review August 28, 2024 18:46

jmuzina mentioned this pull request Aug 28, 2024

Document hero macro #5325

Merged

3 tasks

jmuzina reviewed Aug 28, 2024

View reviewed changes

jmuzina added Review: QA +1 and removed Review: QA needed labels Aug 28, 2024

pastelcyborg added 2 commits August 28, 2024 16:53

Roll back pattern docs

d58f0ff

Update building-vanilla.md

226c64a

pastelcyborg requested a review from jmuzina August 28, 2024 21:04

jmuzina approved these changes Aug 28, 2024

View reviewed changes

jmuzina added Review: Code +1 and removed Review: Code needed labels Aug 28, 2024

pastelcyborg merged commit db3ddef into canonical:feature/expose-macros Aug 28, 2024
4 checks passed

pastelcyborg deleted the add-macro-install-instructions branch August 28, 2024 21:25

jmuzina pushed a commit that referenced this pull request Sep 3, 2024

Add macro install instructions to docs pages (#5330)

d05a8ec

* Update building-vanilla.md * Update pattern docs * Roll back pattern docs * Update building-vanilla.md

jmuzina mentioned this pull request Sep 11, 2024

feat: Publish & Document Jinja Macros #5342

Merged

8 tasks

jmuzina pushed a commit that referenced this pull request Sep 11, 2024

Add macro install instructions to docs pages (#5330)

9ba6d86

* Update building-vanilla.md * Update pattern docs * Roll back pattern docs * Update building-vanilla.md

jmuzina pushed a commit that referenced this pull request Sep 19, 2024

Add macro install instructions to docs pages (#5330)

7f8fe91

* Update building-vanilla.md * Update pattern docs * Roll back pattern docs * Update building-vanilla.md

jmuzina pushed a commit that referenced this pull request Sep 25, 2024

Add macro install instructions to docs pages (#5330)

a37f8de

* Update building-vanilla.md * Update pattern docs * Roll back pattern docs * Update building-vanilla.md

jmuzina pushed a commit that referenced this pull request Oct 3, 2024

Add macro install instructions to docs pages (#5330)

e77a544

* Update building-vanilla.md * Update pattern docs * Roll back pattern docs * Update building-vanilla.md

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add macro install instructions to docs pages #5330

Add macro install instructions to docs pages #5330

pastelcyborg commented Aug 28, 2024 •

edited

Loading

webteam-app commented Aug 28, 2024

Add macro install instructions to docs pages #5330

Add macro install instructions to docs pages #5330

Conversation

pastelcyborg commented Aug 28, 2024 • edited Loading

Done

QA

Check if PR is ready for release

webteam-app commented Aug 28, 2024

Demo

Jenkins

demos.haus

pastelcyborg commented Aug 28, 2024 •

edited

Loading