Skip to content

Port user guide over #5347

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

Merged
merged 53 commits into from
Oct 8, 2018
Merged

Conversation

selbekk
Copy link
Contributor

@selbekk selbekk commented Oct 7, 2018

This pull request moves all of the user guide data into the docusaurus file structure

Huge PR - but it's mostly copy and pasting, while trying to split the content into manageable groups.

We can discuss the way I've split up the content here - but since this is a huge PR that runs the risk of diverging from what's on master in a matter of days, I hope we can consider re-structuring stuff later on instead.


The structure is as follows:

Welcome

  • About the docs

Getting Started

  • Getting started
  • Folder structure
  • Available scripts
  • Supported Browsers
  • Supported Language Features

Development

  • Syntax highlighting
  • In-editor linting
  • Debugging in the Editor
  • Formatting code
  • Proxying in development
  • Developing Components in Isolation
  • Analyzing bundle size

How-to

  • Changing the <title />
  • Installing a Dependency
  • Importing a Component
  • Code Splitting
  • Adding a Stylesheet
  • Adding a CSS Modules Stylesheet
  • Adding a Sass Stylesheet
  • Post-Processing CSS
  • Adding Images, Fonts, and Files
  • Using the public Folder
  • Using Global Variables
  • Adding Bootstrap
  • Adding Flow
  • Adding Relay
  • Adding a Router
  • Adding Custom Environment Variables
  • Can I Use Decorators?
  • Fetching Data with AJAX Requests
  • Integrating with an API Backend
  • Using HTTPS in Development
  • Generating Dynamic <meta> Tags on the Server
  • Pre-Rendering into Static HTML Files
  • Injecting Data from the Server into the Page
  • Making a Progressive Web App
  • Advanced Configuration
  • Alternatives to Ejecting

Testing

  • Running tests
  • Debugging tests

Deployment

  • Publishing to npm
  • Deployment

Support

  • Troubleshooting
  • Updating to New Releases
  • Feedback
  • Something missing?

Addresses #5238

selbekk added 30 commits October 7, 2018 17:51
Copy link
Contributor

@amyrlam amyrlam left a comment

Choose a reason for hiding this comment

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

Wow this was a lot of manual work, nice job! It's def tough to review but yeah, I think your approach sounds 💯

@selbekk
Copy link
Contributor Author

selbekk commented Oct 8, 2018

Yeah 3 hours of manual labor :P Should've written a script or something * + *

Anyhow, I'm merging this so we don't diverge too much. :-)

@selbekk selbekk merged commit f0047bf into facebook:docusaurus Oct 8, 2018
@selbekk selbekk deleted the port-user-guide-over branch October 8, 2018 05:34
@selbekk selbekk mentioned this pull request Oct 8, 2018
20 tasks
@lock lock bot locked and limited conversation to collaborators Jan 18, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants