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

Convert installation instructions #21361

Merged
merged 3 commits into from
Mar 3, 2023
Merged

Convert installation instructions #21361

merged 3 commits into from
Mar 3, 2023

Conversation

kylegach
Copy link
Contributor

@kylegach kylegach commented Mar 2, 2023

What I did

  • Convert installation instructions from FeatureSnippets to CodeSnippets
  • Append @next to storybook
  • Remove ember snippet

Before

image

After

image

Notes

There were two cases that didn't fit the simplified case I ended up with:

  1. ember: There wasn't even a docs/snippets/ember directory, so I'm not sure it should even be listed as a renderer in the docs site.
  2. angular: The prior instructions only used npx and not pnmp. Seemed reasonable to include both.

Without simplifying to use the docs/snippets/common directory, the tabs also displayed the renderer name:

image

That seemed a bit confusing to me, as the installation instructions don't actually differ between renderers (assuming I'm OK in simplifying the two cases above) and its weird to conceptually combine the package manager and the renderer.

How to test

Follow the snippet contribution instructions for this branch

Checklist

  • Make sure your changes are tested (stories and/or unit, integration, or end-to-end tests)
  • Make sure to add/update documentation regarding your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Maintainers

  • If this PR should be tested against many or all sandboxes,
    make sure to add the ci:merged or ci:daily GH label to it.
  • Make sure this PR contains one of the labels below.

["cleanup", "BREAKING CHANGE", "feature request", "bug", "documentation", "maintenance", "dependencies", "other"]

kylegach added 2 commits March 2, 2023 13:09
- From FeatureSnippets to CodeSnippets
- Append `@next` to `storybook`
- Remove `ember` snippet
@kylegach kylegach self-assigned this Mar 2, 2023
@kylegach kylegach requested review from jonniebigodes and domyen March 2, 2023 20:23
@domyen
Copy link
Member

domyen commented Mar 2, 2023

lgtm

Copy link
Member

@domyen domyen left a comment

Choose a reason for hiding this comment

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

love that we removed a bunch of code

Copy link
Contributor

@jonniebigodes jonniebigodes left a comment

Choose a reason for hiding this comment

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

Thanks for the updates, appreciate it 🙏 ! Looks great on my end. Merge away @kylegach

@domyen domyen self-requested a review March 2, 2023 22:51
@kylegach kylegach merged commit 3ea1a30 into next Mar 3, 2023
@kylegach kylegach deleted the update-install-snippets branch March 3, 2023 16:45
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