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

[docs] Switch NJK to WEBC for layout #1428

Closed
markcaron opened this issue Jan 17, 2024 · 11 comments
Closed

[docs] Switch NJK to WEBC for layout #1428

markcaron opened this issue Jan 17, 2024 · 11 comments
Labels
docs Improvements or additions to documentation needs discovery Needs discovery needs refinement This issue needs to be refined

Comments

@markcaron
Copy link
Collaborator

Do it.

image

@markcaron markcaron added docs Improvements or additions to documentation needs discovery Needs discovery needs refinement This issue needs to be refined labels Jan 17, 2024
@markcaron markcaron added this to the 2024/Q1 — Chansey release milestone Jan 17, 2024
@bennypowers
Copy link
Member

i'm concerned about webc's lack of a satisfying dsd support. as an alternative to webc, I would like us to consider lit-11ty

@zeroedin
Copy link
Collaborator

@bennypowers
Copy link
Member

yes, that or something like it. the idea being that instead of webc components we'd write uxdot-specific lit components and ssr them by way of dsd, using the plugin

@zeroedin
Copy link
Collaborator

zeroedin commented Jan 25, 2024

Do we need a list of uxdot/elements that we are going to create for this? Elements that aren't quite RHDS elements but need a home.

Here is a shortlist that exist or might be additionally needed (with screenshots of specific parts I'm referencing):

  • masthead - need to include github link image
  • article/page header (maybe an option for with or without slotted subnav)
    image
  • sample/example - already being worked on in docs: samples #1350
  • installation-tabs - already live
  • maybe specialized rh-table usecase wrapper components?

Anyone have any other elements on the page they think might serve well as uxdot/components?

@zeroedin
Copy link
Collaborator

Given inclusion with 11ty-plugin-lit, how do we handle eleventy based templating? Are we still using njk for that? Do we just pair that down as much as possible what can go into a component and what can't?

Example: I want to loop through 11ty's data cascade?

@bennypowers
Copy link
Member

we already have docs/assets/elements (iirc) and more in the docs: sample pr

@zeroedin
Copy link
Collaborator

https://github.com/lit/lit/tree/main/packages/labs/eleventy-plugin-lit#passing-data-to-components

Ok so the idea is there but no actual way to do that yet.

If we are to get this done this quarter, then that doesn't look promising given the timeline.

So will we have to fall back to something like: <some-component name="{{ data.name}}"> that is still powered by njk? After compile then passing the compiled html output to the plugin for DSD'ing?

@bennypowers
Copy link
Member

maybe lit/lit#2485 (comment)

@markcaron
Copy link
Collaborator Author

Going a different route with components.

@github-project-automation github-project-automation bot moved this from Backlog to Done ☑️ in Red Hat Design System Feb 22, 2024
@zeroedin
Copy link
Collaborator

Cleanup for potential move to using elventy-lit-plugin has been done in the docs rewrite PR: #1465

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation needs discovery Needs discovery needs refinement This issue needs to be refined
Projects
Status: Done ☑️
Development

No branches or pull requests

3 participants