mirror of
https://github.com/facebook/docusaurus.git
synced 2025-05-10 15:47:23 +02:00
Replace facebookexperimental with facebook (#266)
Moving to the facebook GitHub org
This commit is contained in:
parent
643c7a4047
commit
ef6f550700
13 changed files with 22 additions and 22 deletions
|
@ -58,7 +58,7 @@ jobs:
|
||||||
- run:
|
- run:
|
||||||
name: Configure GitHub Bot
|
name: Configure GitHub Bot
|
||||||
command: |
|
command: |
|
||||||
if [[ $CIRCLE_PROJECT_USERNAME == "facebookexperimental" && -z $CI_PULL_REQUEST && -z $CIRCLE_PR_USERNAME ]]; then
|
if [[ $CIRCLE_PROJECT_USERNAME == "facebook" && -z $CI_PULL_REQUEST && -z $CIRCLE_PR_USERNAME ]]; then
|
||||||
git config --global user.email "docusaurus@users.noreply.github.com"
|
git config --global user.email "docusaurus@users.noreply.github.com"
|
||||||
git config --global user.name "Website Deployment Script"
|
git config --global user.name "Website Deployment Script"
|
||||||
echo "machine github.com login facebook-github-bot" > ~/.netrc
|
echo "machine github.com login facebook-github-bot" > ~/.netrc
|
||||||
|
@ -66,7 +66,7 @@ jobs:
|
||||||
- run:
|
- run:
|
||||||
name: Deploy Website
|
name: Deploy Website
|
||||||
command: |
|
command: |
|
||||||
if [[ $CIRCLE_PROJECT_USERNAME == "facebookexperimental" && -z $CI_PULL_REQUEST && -z $CIRCLE_PR_USERNAME ]]; then
|
if [[ $CIRCLE_PROJECT_USERNAME == "facebook" && -z $CI_PULL_REQUEST && -z $CIRCLE_PR_USERNAME ]]; then
|
||||||
echo "Deploying website..."
|
echo "Deploying website..."
|
||||||
cd website && GIT_USER=facebook-github-bot USE_SSH=true yarn run publish-gh-pages
|
cd website && GIT_USER=facebook-github-bot USE_SSH=true yarn run publish-gh-pages
|
||||||
else
|
else
|
||||||
|
|
|
@ -29,7 +29,7 @@ Read our [contributing guide](https://docusaurus.io/docs/how-to-contribute.html)
|
||||||
|
|
||||||
### Beginner Friendly Bugs
|
### Beginner Friendly Bugs
|
||||||
|
|
||||||
To help you get your feet wet and get you familiar with our contribution process, we have a list of [beginner friendly bugs](https://github.com/facebookexperimental/Docusaurus/labels/Difficulty%3A%20beginner) that contain bugs which are fairly easy to fix. This is a great place to get started.
|
To help you get your feet wet and get you familiar with our contribution process, we have a list of [beginner friendly bugs](https://github.com/facebook/Docusaurus/labels/Difficulty%3A%20beginner) that contain bugs which are fairly easy to fix. This is a great place to get started.
|
||||||
|
|
||||||
### License
|
### License
|
||||||
|
|
||||||
|
|
|
@ -23,7 +23,7 @@ The version number should generally increase by some factor than the current one
|
||||||
"version": "1.0.0-alpha.41",
|
"version": "1.0.0-alpha.41",
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "https://github.com/facebookexperimental/Docusaurus.git"
|
"url": "https://github.com/facebook/Docusaurus.git"
|
||||||
},
|
},
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
|
@ -76,7 +76,7 @@ Alias: `publish-gh-pages`
|
||||||
|
|
||||||
- `GIT_USER`: The git user to be associated with the deploy commit.
|
- `GIT_USER`: The git user to be associated with the deploy commit.
|
||||||
- `CIRCLE_BRANCH`: The git branch associated with the commit that triggered the CI run.
|
- `CIRCLE_BRANCH`: The git branch associated with the commit that triggered the CI run.
|
||||||
- `CIRCLE_PROJECT_USERNAME`: The GitHub username or organization name that hosts the git repo, e.g. "FacebookExperimental".
|
- `CIRCLE_PROJECT_USERNAME`: The GitHub username or organization name that hosts the git repo, e.g. "facebook".
|
||||||
- `CIRCLE_PROJECT_REPONAME`: The name of the git repo, e.g. "Docusaurus".
|
- `CIRCLE_PROJECT_REPONAME`: The name of the git repo, e.g. "Docusaurus".
|
||||||
- `CI_PULL_REQUEST`: Expected to be truthy if the current CI run was triggered by a commit in a pull request.
|
- `CI_PULL_REQUEST`: Expected to be truthy if the current CI run was triggered by a commit in a pull request.
|
||||||
|
|
||||||
|
|
|
@ -127,7 +127,7 @@ const siteConfig = {
|
||||||
// url: "https://www.example.com",
|
// url: "https://www.example.com",
|
||||||
baseUrl: "/test-site/",
|
baseUrl: "/test-site/",
|
||||||
// baseUrl: "/",
|
// baseUrl: "/",
|
||||||
organizationName: "facebookexperimental",
|
organizationName: "facebook",
|
||||||
projectName: "docusaurus",
|
projectName: "docusaurus",
|
||||||
noIndex: false,
|
noIndex: false,
|
||||||
headerLinks: [
|
headerLinks: [
|
||||||
|
|
|
@ -33,8 +33,8 @@ Most of the work to publish to GitHub pages is done for you automatically throug
|
||||||
|
|
||||||
Two of the required parameters are set in the [`siteConfig.js`](api-site-config.md):
|
Two of the required parameters are set in the [`siteConfig.js`](api-site-config.md):
|
||||||
|
|
||||||
- `organizationName`: The GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebookexperimental" GitHub organization.
|
- `organizationName`: The GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
|
||||||
- `projectName`: The name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebookexperimental/docusaurus, so our project name in this case would be "docusaurus".
|
- `projectName`: The name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
|
||||||
|
|
||||||
> While we recommend setting the above in `siteConfig.js`, you can also use environment variables `ORGANIZATION_NAME` and `PROJECT_NAME`.
|
> While we recommend setting the above in `siteConfig.js`, you can also use environment variables `ORGANIZATION_NAME` and `PROJECT_NAME`.
|
||||||
|
|
||||||
|
@ -60,7 +60,7 @@ GIT_USER=<GIT_USER> \
|
||||||
|
|
||||||
> The specified `GIT_USER` must have push access to the repository specified in the combination of `organizationName` and `projectName`.
|
> The specified `GIT_USER` must have push access to the repository specified in the combination of `organizationName` and `projectName`.
|
||||||
|
|
||||||
You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://organizationName.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://docusaurus.io (it can also be accessed via https://facebookexperimental.github.io/docusaurus), because it is served from the `gh-pages` branch of the https://github.com/facebookexperimental/docusaurus GitHub repo. We highly encourage reading through the [GitHub Pages documentation](https://pages.github.com) to learn more about how this hosting solution works.
|
You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://organizationName.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://docusaurus.io (it can also be accessed via https://facebook.github.io/docusaurus), because it is served from the `gh-pages` branch of the https://github.com/facebook/docusaurus GitHub repo. We highly encourage reading through the [GitHub Pages documentation](https://pages.github.com) to learn more about how this hosting solution works.
|
||||||
|
|
||||||
You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.
|
You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.
|
||||||
|
|
||||||
|
|
|
@ -110,7 +110,7 @@ Custom links can be added to the site navigation bar with the following entry in
|
||||||
```
|
```
|
||||||
headerLinks: [
|
headerLinks: [
|
||||||
...
|
...
|
||||||
{ href: 'https://github.com/facebookexperimental/Docusaurus', label: 'GitHub' },
|
{ href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
|
||||||
...
|
...
|
||||||
],
|
],
|
||||||
```
|
```
|
||||||
|
|
|
@ -38,7 +38,7 @@
|
||||||
"version": "1.0.0-beta.15",
|
"version": "1.0.0-beta.15",
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "https://github.com/facebookexperimental/Docusaurus.git"
|
"url": "https://github.com/facebook/Docusaurus.git"
|
||||||
},
|
},
|
||||||
"bin": {
|
"bin": {
|
||||||
"docusaurus-start": "./lib/start-server.js",
|
"docusaurus-start": "./lib/start-server.js",
|
||||||
|
|
|
@ -41,12 +41,12 @@ class Footer extends React.Component {
|
||||||
</div>
|
</div>
|
||||||
<div>
|
<div>
|
||||||
<h5>More</h5>
|
<h5>More</h5>
|
||||||
<a href="https://github.com/facebookexperimental/docusaurus">
|
<a href="https://github.com/facebook/docusaurus">
|
||||||
GitHub
|
GitHub
|
||||||
</a>
|
</a>
|
||||||
<a
|
<a
|
||||||
className="github-button"
|
className="github-button"
|
||||||
href="https://github.com/facebookexperimental/docusaurus"
|
href="https://github.com/facebook/docusaurus"
|
||||||
data-icon="octicon-star"
|
data-icon="octicon-star"
|
||||||
data-show-count="true"
|
data-show-count="true"
|
||||||
aria-label="Star this project on GitHub"
|
aria-label="Star this project on GitHub"
|
||||||
|
|
|
@ -23,7 +23,7 @@ class Help extends React.Component {
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
content:
|
content:
|
||||||
"Submit issues and pull requests for any new features you may want to see or bugs you've found on [GitHub](https://github.com/facebookexperimental/docusaurus).",
|
"Submit issues and pull requests for any new features you may want to see or bugs you've found on [GitHub](https://github.com/facebook/docusaurus).",
|
||||||
title: "Join the community"
|
title: "Join the community"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|
|
@ -169,7 +169,7 @@ class Index extends React.Component {
|
||||||
contents={[
|
contents={[
|
||||||
{
|
{
|
||||||
content:
|
content:
|
||||||
"Docusaurus currently provides support to help your website use [translations](/docs/translation.html), [search](/docs/search.html), and [versioning](/docs/versioning.html), along with some other special [documentation markdown features](/docs/doc-markdown.html). If you have ideas for useful features, feel free to contribute on [GitHub](https://github.com/facebookexperimental/docusaurus)!",
|
"Docusaurus currently provides support to help your website use [translations](/docs/translation.html), [search](/docs/search.html), and [versioning](/docs/versioning.html), along with some other special [documentation markdown features](/docs/doc-markdown.html). If you have ideas for useful features, feel free to contribute on [GitHub](https://github.com/facebook/docusaurus)!",
|
||||||
imageAlign: "right",
|
imageAlign: "right",
|
||||||
image: `${siteConfig.baseUrl}img/docusaurus_monochrome.svg`,
|
image: `${siteConfig.baseUrl}img/docusaurus_monochrome.svg`,
|
||||||
title: "Website Features"
|
title: "Website Features"
|
||||||
|
|
|
@ -33,7 +33,7 @@ class Users extends React.Component {
|
||||||
<div className="logos">{showcase}</div>
|
<div className="logos">{showcase}</div>
|
||||||
<p>Are you using this project?</p>
|
<p>Are you using this project?</p>
|
||||||
<a
|
<a
|
||||||
href="https://github.com/facebookexperimental/docusaurus/edit/master/website/siteConfig.js"
|
href="https://github.com/facebook/docusaurus/edit/master/website/siteConfig.js"
|
||||||
className="button">
|
className="button">
|
||||||
Add your project
|
Add your project
|
||||||
</a>
|
</a>
|
||||||
|
|
|
@ -50,19 +50,19 @@ const siteConfig = {
|
||||||
tagline: "Easy to Maintain Open Source Documentation Websites",
|
tagline: "Easy to Maintain Open Source Documentation Websites",
|
||||||
url: "https://docusaurus.io",
|
url: "https://docusaurus.io",
|
||||||
baseUrl: "/",
|
baseUrl: "/",
|
||||||
organizationName: "facebookexperimental",
|
organizationName: "facebook",
|
||||||
projectName: "Docusaurus",
|
projectName: "Docusaurus",
|
||||||
cname: "docusaurus.io",
|
cname: "docusaurus.io",
|
||||||
noIndex: true,
|
noIndex: true,
|
||||||
users,
|
users,
|
||||||
editUrl:
|
editUrl:
|
||||||
"https://github.com/facebookexperimental/docusaurus/edit/master/docs/",
|
"https://github.com/facebook/docusaurus/edit/master/docs/",
|
||||||
headerLinks: [
|
headerLinks: [
|
||||||
{ doc: "installation", label: "Docs" },
|
{ doc: "installation", label: "Docs" },
|
||||||
{ page: "help", label: "Help" },
|
{ page: "help", label: "Help" },
|
||||||
{ blog: true, label: "Blog" },
|
{ blog: true, label: "Blog" },
|
||||||
{
|
{
|
||||||
href: "https://github.com/facebookexperimental/docusaurus",
|
href: "https://github.com/facebook/docusaurus",
|
||||||
label: "GitHub"
|
label: "GitHub"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue