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.

Sign up for GitHub

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

Jump to bottom

Documentation #1

Closed
priley86 opened this issue Mar 8, 2017 · 3 comments
Closed

Documentation #1

priley86 opened this issue Mar 8, 2017 · 3 comments

Comments

@priley86
Copy link
Member

priley86 commented Mar 8, 2017

API Documentation

We'd like to choose a tool which generates API docs for our code. To date in Patternfly, we've used tools like jsdoc. What kinds of API docs would you prefer to see used?

Showcase Documentation

We have a few tools being used in Patternfly today for showcasing our components. There is patternfly.org, patternlab (for patternfly-css) demo, and our patternfly-webcomponents site. What kind of showcase site style would we like?

Component / Widget Documentation

Today in Patternfly, we use test pages for sharing our new components. We also build these in Travis under our forks to share in PRs. What kind of test pages would we like to see used?
@priley86 priley86 mentioned this issue Mar 17, 2017
Closed
@priley86
Copy link
Member Author

Any thoughts on react-docgen as opposed to using jsdocs ?

@priley86
Copy link
Member Author

priley86 commented Apr 7, 2017

It looks like react-storybook-addon-info supports react-docgen comments in our components. Still awaiting this upstream PR to be merged...
storybook-eol/react-storybook-addon-info#122

@priley86
Copy link
Member Author

Referencing #37 : this has now been resolved in Storybook 3.

@priley86 priley86 mentioned this issue Nov 13, 2017
Closed
@AparnaKarve AparnaKarve mentioned this issue Jan 24, 2018
Merged
@jgiardino jgiardino mentioned this issue Mar 15, 2019
Merged
This was referenced May 9, 2019
Closed
Merged
@dlabrecq dlabrecq mentioned this issue Jun 3, 2019
Closed
@jenny-s51 jenny-s51 mentioned this issue Jul 15, 2019
Merged
@dlabrecq dlabrecq mentioned this issue Sep 15, 2019
Closed
@dlabrecq dlabrecq mentioned this issue Jun 5, 2020
Closed
seanforyou23 referenced this issue in seanforyou23/patternfly-react Jun 5, 2020
@nicolethoen
Merge pull request #1 from seanforyou23/nicolethoen-inline_edit_dropdown

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode
a3123af 
fix(cancel-edit): ensure cancel operation reverts selected value
@mcarrano mcarrano mentioned this issue Mar 23, 2022
Merged
@mcarrano mcarrano mentioned this issue Aug 4, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@priley86