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

Remove outdated restriction regarding docs nesting #746

Merged
merged 1 commit into from
Jun 10, 2018
Merged

Remove outdated restriction regarding docs nesting #746

merged 1 commit into from
Jun 10, 2018

Conversation

yangshun
Copy link
Contributor

Motivation

@endiliey shipped a feature to allow doc nesting. This PR removes the outdated restriction in siteConfig regarding docs nesting.

Have you read the Contributing Guidelines on pull requests?

Yes

Test Plan

NA. Doc change.

Related PRs

#705

@yangshun yangshun requested a review from endiliey June 10, 2018 08:14
@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Jun 10, 2018
@docusaurus-bot
Copy link
Contributor

Deploy preview for docusaurus-preview ready!

Built with commit 88387e3

https://deploy-preview-746--docusaurus-preview.netlify.com

Copy link
Contributor

@endiliey endiliey left a comment

Choose a reason for hiding this comment

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

Thanks for this 😄

@yangshun
Copy link
Contributor Author

@endiliey On a side note, I have the following questions:

  1. Does nested docs dirs work for custom doc path?
  2. Could we try to convert the existing docs dir to nested? So as to dogfood the feature 😄

@yangshun yangshun merged commit ffe782a into master Jun 10, 2018
@endiliey
Copy link
Contributor

endiliey commented Jun 10, 2018

@yangshun

  1. yup because the main logic is on determining the subDir which depends on the reference directory

https://github.com/facebook/Docusaurus/blob/ffe782a669537505904da6af3cc7b73577b87bb5/lib/server/utils.js#L11-L19

I just found out a typo
should be refDir: 'docs')

  1. I wanted to do that but I'm wondering if I must do it for previous version as well. That's a lot 😢

Edit: @JoelMarcey mentioned he wanted to dogfood https://github.com/facebook/Docusaurus/tree/master/admin

@yangshun
Copy link
Contributor Author

yangshun commented Jun 10, 2018

How about writing a script to migrate the current and versioned docs to nested?

  1. Split each filename by hyphen.
  2. Take the first word and create a dir.
  3. Shift filenames with the same first word into the dir.
  4. Rename the filename and strip off the dir.

I can try doing that tomorrow 👍 But do let me know if you want to do it instead

@endiliey
Copy link
Contributor

endiliey commented Jun 10, 2018

@yangshun appreciate it if you could help me on that. I'll be out of reach from my laptop in the next few hours for a week. No wifi & laptop at hospital 😢. Relying on mobile data :(

@yangshun
Copy link
Contributor Author

No problem, I'll take care of it. Rest well! Take care 😄

@endiliey
Copy link
Contributor

endiliey commented Jun 10, 2018

Thanks 😂 . On a side note, actually we have to basically replace all markdown linking

Example:

[Installation guide](getting-started-installation.md).

to

[Installation guide](getting-started/installation.md).

Edit: I'm also not sure if our translation at Crowdin will reset to 0 if we change the docs file name

@JoelMarcey
Copy link
Contributor

I thought moving admin to its own folder under docs would gives the least friction way to have this running on Docusaurus -- which I definitely think we should. I do not mind moving our docs to their own folder as well.

Or #whynotboth 😄

Split each filename by hyphen.
Take the first word and create a dir.

@yangshun I don't think this works for getting-started though, which we would want as the directory name. Not getting 😄

@JoelMarcey
Copy link
Contributor

I'm also not sure if our translation at Crowdin will reset to 0 if we change the docs file name

That's a good point @endiliey. We will need to take into account the affect on our translations. I will need to ask @ericnakagawa or the folks at Crowdin on the affect of a file move.

But we can still start with admin while we wait.

@JoelMarcey JoelMarcey deleted the docs branch March 9, 2019 05:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Signed Facebook CLA
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants