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

chore(exp): add experimental feature support #2031

Merged
merged 4 commits into from
Jul 10, 2019

Conversation

dgutride
Copy link
Member

@dgutride dgutride commented Jul 9, 2019

Fixes #1950

@patternfly-build
Copy link

patternfly-build commented Jul 9, 2019

Deploy preview for pf-next ready!

Built with commit 80e779c

https://deploy-preview-2031--pf-next.netlify.com

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
dgutride and others added 2 commits July 9, 2019 16:21
Co-Authored-By: Michael Coker <[email protected]>
Co-Authored-By: Michael Coker <[email protected]>
@@ -0,0 +1,10 @@
module.exports = [
{
name: 'ComponentName',
Copy link
Contributor

Choose a reason for hiding this comment

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

what does the value for name represent?

Copy link
Member Author

Choose a reason for hiding this comment

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

It's the component name - like Badge or Alert

Copy link
Contributor

Choose a reason for hiding this comment

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

Oh sorry, I mean what is it's function in indicating a feature as experimental? I expected the value to be used as the link name in the navigation, but looks like that link is generated from the component/layout/utility name.

Copy link
Member Author

Choose a reason for hiding this comment

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

Good catch - I am not directly using this value anywhere, but I left it in since I think it more clearly articulates in the json values what is being indicated. I can remove it - but it seemed to improve readability of the file when it was in there.

Copy link
Contributor

Choose a reason for hiding this comment

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

works for me either way.

## Experimental components

When creating a brand new component, it should be released as experimental in order to get feedback. This results in the css not being bundled into the full distribution (`patternfly.css`), but the component level css is still included in the npm package for usage.

Copy link
Member

Choose a reason for hiding this comment

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

Should we provide specific instructions here on how to add/name the style sheet associated with that experimental component? What happens if the experimental component includes updating styles from another component/or global styles?

Copy link
Member Author

Choose a reason for hiding this comment

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

Let's hold off on that until we can meet to discuss how we are going to use this. I would like to get this into use and talk to you guys about the possibilities. There should be no updating or usage of other components or interaction of styles in the first pass of using these - these are meant to be brand new components, not modifications of existing nor changes to anything global.

Copy link
Contributor

@mcoker mcoker left a comment

Choose a reason for hiding this comment

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

🥇

@redallen redallen merged commit 66f58d0 into patternfly:master Jul 10, 2019
@patternfly-build
Copy link

🎉 This PR is included in version 2.17.3 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants