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

5238 set up basic docs structure #5245

Merged
merged 10 commits into from
Oct 3, 2018

Conversation

selbekk
Copy link
Contributor

@selbekk selbekk commented Oct 2, 2018

This pull request adds two docs sections - "Getting Started" and "User Guide".

The "Getting Started" part is just a copy of parts of the main README for now, while the "User Guide" just links to the user guide found on GitHub.

And with this - we can actually start the project locally!

Adresses #5238

docs/README.md Outdated
@@ -0,0 +1,3 @@
# Nothing to see here right now

Please refer to the [Readme](https://github.com/facebook/create-react-app/blob/master/README.md) or the [User Guide](https://github.com/facebook/create-react-app/blob/master/README.md#getting-started).
Copy link
Contributor

Choose a reason for hiding this comment

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

This can just be the user guide.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure, I'll just copy paste it in there for now. We should probably split it up at some point though.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah sorry, I mis-read you. Yep, will fix the link

@selbekk selbekk force-pushed the 5238-set-up-basic-docs-structure branch from a95a842 to 5a0bd94 Compare October 2, 2018 15:24
@gaearon
Copy link
Contributor

gaearon commented Oct 3, 2018

Can we figure out a way to avoid a super visible docs directory until we're actually comfortable with these being final docs? Our users will try to go there and be confused by drafts.

Something like website-docs-wip would work better in the meantime.

@selbekk
Copy link
Contributor Author

selbekk commented Oct 3, 2018

Unfortunately, that seems to be a hard requirement from docusaurus. We could, however, move the entire website folder into a new location, as all docusaurus is asking for is a folder named «docs» as a sibling to the «website» folder.

How about this:

  1. move ~/website to ~/docusaurus/website
  2. move ~/docs to ~/docusaurus/docs
  3. move both one level up once done (if we want to, I think we can put it wherever - but @amyrlam probably knows that better than I)

Sounds like a plan?

@gaearon
Copy link
Contributor

gaearon commented Oct 3, 2018

Okay that sounds good.

@selbekk selbekk force-pushed the 5238-set-up-basic-docs-structure branch from 8f54c0e to 8dbf494 Compare October 3, 2018 19:19
@amyrlam
Copy link
Contributor

amyrlam commented Oct 3, 2018

Shall we cut a docusaurus branch off master now and move this PR and #5251 there? A good chunk of selbekk's work got merged, nice! Up for whatever you all prefer. @selbekk sent you a DM on Twitter

@gaearon gaearon merged commit 4bda8f7 into facebook:master Oct 3, 2018
@gaearon
Copy link
Contributor

gaearon commented Oct 3, 2018

I merged this into master but I also pushed a docusaurus branch.

I agree it probably makes more sense to start working in it directly than create noise on master. How about this arrangement:

  • You can both work against docusaurus
  • You can review each other's PRs
  • Tell me or @Timer (here or on Twitter DM) when you're happy with PRs and we'll press Merge

@gaearon
Copy link
Contributor

gaearon commented Oct 3, 2018

Also thanks again for working on this, I'm super excited we'll get a real website!

@amyrlam
Copy link
Contributor

amyrlam commented Oct 3, 2018

sounds good, thanks!

@selbekk selbekk deleted the 5238-set-up-basic-docs-structure branch October 4, 2018 06:16
@selbekk
Copy link
Contributor Author

selbekk commented Oct 4, 2018

Good by me as well :) go team!

@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