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(get-started): Updates dev onboarding guide for v6. #3892

Merged
merged 5 commits into from
May 16, 2024

Conversation

edonehoo
Copy link
Collaborator

Closes #3888

@edonehoo edonehoo changed the base branch from main to v6 February 19, 2024 18:12
@patternfly-build
Copy link
Contributor

patternfly-build commented Feb 19, 2024

@edonehoo
Copy link
Collaborator Author

@nicolethoen @srambach hi, this is ready for review! But I don't think technically corrects anything necessary for the alpha release (if other prs are higher priority to get in)

Copy link
Member

@srambach srambach left a comment

Choose a reason for hiding this comment

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

Great changes! Just a few nits.


The React library provides a collection of React components you can use to build interfaces with consistent markup, styling, and behavior.
[PatternFly's React library](https://github.com/patternfly/patternfly-react) contains a collection of components that you can use to build interfaces with consistent markup, styling, and behavior. It is composed of a number of React implementations, which are published in the following npm packages:
Copy link
Member

Choose a reason for hiding this comment

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

"implementations" doesn't feel like the right word here.. to me, that means the same thing built in different ways. I guess we can't say "components" since that has a more specific meaning...packages seems like the right word even though I realize it's used a couple of times right there.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

ah true! For the sake of accuracy, maybe it's okay to use packages a couple of times. Or we could say "published on/at npm", but I'm not sure if that's an accurate way to refer to npm? Changing it to "packages" for now, though


* [Use npm](https://nodejs.org/en/download)
* [Use Yarn](https://yarnpkg.com/en/docs/getting-started)
1. [Learn about our design token system](/tokens/about-tokens), which enables you to build interfaces with consistent PatternFly styling, including colors, shadows, spacing, and more.
Copy link
Member

Choose a reason for hiding this comment

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

This link returns a 404 for me, but maybe that's just because things are still in flight?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

oh yeah since the current url is https://staging-v6.patternfly.org/tokens/about-tokens, but since this pr merges into the v6 branch I think what I have should work once this doc goes live with v6?

Copy link
Member

@srambach srambach left a comment

Choose a reason for hiding this comment

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

🍰 Thanks!

@jessiehuff jessiehuff merged commit 49a875b into patternfly:v6 May 16, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Review and update "develop" get started page.
5 participants