-
-
Notifications
You must be signed in to change notification settings - Fork 26.9k
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
Porting documentation to Docusaurus #5238
Comments
This makes sense. I think we should figure out a good high-level structure for User Guide before diving into this work. We'd want to group it into higher level sections. |
That's fine by me. 🙂 You can do some thinking on that while I start with some of the more "get-it-done"-tasks? :) |
Challenge: Docusaurus requires a |
Adding a top level |
A few concerns before we launch this for the first time.
|
So most of this is done, with the exception of copywriting and branding things. |
We should probably make the docs searchable as well, but I think we can release this as is now. @amyrlam has done some research here. We need to configure Docusaurus and then we need to set up Algolia's DocSearch. The latter, which will create an API key, is probably best done by one of the maintainers. Once it's done, send me the API key, and I'll create a pull request enabling the search feature. |
Really awesome this is out! Docusaurus folks are super excited!
|
I did that. I also truncated the generated README to be very short although we can still make it shorter. |
Ah sorry about that - makes sense now. The README seems good as-is! Updated my comment and other checkboxes above. Do you still want to add Algolia search? Could be a quick win. CRA team will need to sign up https://community.algolia.com/docsearch/who-can-apply.html to get the API key. Docusaurus has already added CRA as a user 😄: facebook/docusaurus#1050 |
You're a part of the team now, so maybe you could do it? :-) |
Ok cool - sure thing, I'll do that |
We also need to set up docs to release from CI. |
Submitted to Algolia - sounds like may take a few days. Should be a straightforward PR! // As for setting up docs to release from CI...not super familiar with GitHub Pages or Appveyor but took a stab at it here: #5496 (work in progress) Let me know if you have any ideas to help move forward. Also if you could fill in some of the git stuff. TIL the |
This is awesome, nice work!! Something that would be eventually nice would be versioning the docs like the React ones are and pointing the versioned docs in the template generated by CRA 👍 |
Hello 👋 Docusaurus maintainer here. Really happy to see this happening. Thanks for doing this to all people involved. ☺ |
@petetnt 👋 Was thinking of waiting to version docs til https://github.com/facebook/docusaurus v2.0 is out. But if there are a lot of changes, could start versioning docs? Would be good to get the docs on continuous deployment first... // Here's the Algolia PR, woot: #5551 |
Versioning is probably something we'll want eventually. I created an issue so we don't forget about this: #5560 |
Since this issue is still open, I thought I'd pile on...:
It redirects to Who has the keys to that bit.ly account? |
@selbekk Can you add my point (comment right above) about the |
Seems that CI is not yet setup for CRA documentation. |
This issue has been automatically marked as stale because it has not had any recent activity. It will be closed in 5 days if no further activity occurs. |
I guess this issue could be closed now. Thanks for all participating members! |
Ref #5209, this issue will work as a base for planning the work of creating a Docusaurus documentation website for
create-react-app
.Task list
An initial task overview might look like this:
siteConfig.js
file with correct names (@selbekk / Set the project name and owner correctly #5243)This task list will be updated, edited and changed as we come up with more tasks, or split larger ones up into smaller ones.
Documentation structure
There are many ways of structuring the content found in this repo, but I think a good first approach is to split it into two parts:
From there, we can split it up into more narrow "groups", if we find it appropriate and helpful for the user.
The text was updated successfully, but these errors were encountered: