Support for Docusaurus gh-pages on Github Enterprise #689
Conversation
|
Thank you for your pull request and welcome to our community. We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file. In order for us to review and merge your code, please sign up at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need the corporate CLA signed. If you have received this in error or have any questions, please contact us at cla@fb.com. Thanks! |
|
Deploy preview for docusaurus-preview ready! Built with commit f1d0b01 |
|
Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Facebook open source project. Thanks! |
|
Finally understand how prettier works. Resubmitting. |
There was a problem hiding this comment.
@ranolf Thanks! This seems like a good PR. I just have one suggestion.
docs/api-site-config.md
Outdated
| @@ -64,6 +64,8 @@ headerLinks: [ | |||
|
|
|||
| `url` - url for your site. | |||
|
|
|||
| `githubHost` - (optional) if you're using GitHub Enterprise, hostname of your server. | |||
There was a problem hiding this comment.
Given that this is optional, I wonder if this should go in the Optional Fields section? I kinda get why you put it here, but maybe just to be consistent, we should move it.
Motivation
In attempting to use Docusaurus for internal documentation in my employer's Github Enterprise server, I discovered that publish-gh-pages script assumes github.com.
Have you read the Contributing Guidelines on pull requests?
Yes. I found no issue even matching 'enterprise', which I would expect if others had tried this.
Test Plan
I verified by actually publishing to my company's Github Enterprise server.
Related PRs
(If this PR adds or changes functionality, please take some time to update the docs at https://github.com/facebook/docusaurus, and link to your PR here.)
I updated the appropriate docs files in the
masterbranch:I assume that your CI process uses docs in master and runs a
publish-gh-pages; and thus there is no need for a separate PR for docs?Let me know, I'm happy to include a separate PR if necessary.