Frontend documentation and components gallery #4383
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 30 commits
November 22, 2017 11:36
- Include shared components in the gallery - Add build scripts to build the gallery and serve it
React Select uses `labelKey` instead of `displayKey` so pass the right prop down.
This prop was not updated when we migrated to our own Input component.
We used the wrong import here, `moment` doesn't know about timezones.
As we specify the `onChange` prop in the TimezoneSelect prop types, we should at least use it instead of passing it down as other props that are not listed. We should restrict the supported props at some point, protecting our code from changes in underlying components.
added 7 commits
November 29, 2017 15:38
ghost
assigned 
|
As I change many files in here, it's normal the linter is complaining. I didn't see any warnings in IntelliJ while writing the documentation, so I hope there are no new issues from the changes in here. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR introduces a frontend documentation site built with React Styleguidist.
The documentation and site is still in a very early stage, but I think it's better to merge the changes sooner than later, since there are already lots of them.
As a summary, I took care of two things in this PR:
commoncomponents. For now I also included other components in the gallery, but they are still not documented. I will take care of that in further PRsTo see the new documentation site, we have two new yarn scripts that let you do that:
yarn run docs:serverwill run a development server with the documentationyarn run docs:buildwill generate HTML that can be used to serve the site from the local system or another serverI'm sorry about the length of the PR 🐙 I can split it up if the reviewer thinks that will make the task easier.