diff --git a/.circleci/config.yml b/.circleci/config.yml index 599b843af0..30a2bc7e83 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -58,7 +58,7 @@ jobs: - run: name: Configure GitHub Bot 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.name "Website Deployment Script" echo "machine github.com login facebook-github-bot" > ~/.netrc @@ -66,7 +66,7 @@ jobs: - run: name: Deploy Website 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..." cd website && GIT_USER=facebook-github-bot USE_SSH=true yarn run publish-gh-pages else diff --git a/README.md b/README.md index ab2aef9408..43f6b0fb11 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ Read our [contributing guide](https://docusaurus.io/docs/how-to-contribute.html) ### 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 diff --git a/admin/publish.md b/admin/publish.md index 4fd9490b9e..b62766442d 100644 --- a/admin/publish.md +++ b/admin/publish.md @@ -23,7 +23,7 @@ The version number should generally increase by some factor than the current one "version": "1.0.0-alpha.41", "repository": { "type": "git", - "url": "https://github.com/facebookexperimental/Docusaurus.git" + "url": "https://github.com/facebook/Docusaurus.git" }, ``` diff --git a/docs/api-commands.md b/docs/api-commands.md index 54cc59993f..7bfc7d292b 100644 --- a/docs/api-commands.md +++ b/docs/api-commands.md @@ -9,7 +9,7 @@ Docusaurus provides a set of scripts to help you generate, serve, and deploy you * [`yarn run examples`](api-commands.md#docusaurus-examples): create example configuration files -## Running from the command line +## Running from the command line The scripts can be run using either Yarn or npm. If you've already gone through our Getting Started guide, you may already be familiar with the `start` command. It's the command that tells Docusaurus to run the `docusaurus-start` script which generates the site and starts up a server, and it's usually invoked like so: @@ -56,7 +56,7 @@ Docusaurus provides some default mappings to allow you to run commands following ### `docusaurus-build` Alias: `build`. -Generates the static website, applying translations if necessary. Useful for building the website prior to deployment. +Generates the static website, applying translations if necessary. Useful for building the website prior to deployment. See also [`docusaurus-start`](api-commands.md#docusaurus-start-port-number). @@ -76,7 +76,7 @@ Alias: `publish-gh-pages` - `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_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". - `CI_PULL_REQUEST`: Expected to be truthy if the current CI run was triggered by a commit in a pull request. @@ -94,7 +94,7 @@ See the [Versioning guide](guides-versioning.md#renaming-existing-versions) to l --- ### `docusaurus-start [--port ]` -Alias: `start`. +Alias: `start`. This script will build the static website, apply translations if necessary, and then start a local server. The website will be served from port 3000 by default. diff --git a/docs/api-site-config.md b/docs/api-site-config.md index fbfaed5596..fffccc88f5 100644 --- a/docs/api-site-config.md +++ b/docs/api-site-config.md @@ -127,7 +127,7 @@ const siteConfig = { // url: "https://www.example.com", baseUrl: "/test-site/", // baseUrl: "/", - organizationName: "facebookexperimental", + organizationName: "facebook", projectName: "docusaurus", noIndex: false, headerLinks: [ diff --git a/docs/getting-started-publishing.md b/docs/getting-started-publishing.md index b68f418a79..17d3c55dc5 100644 --- a/docs/getting-started-publishing.md +++ b/docs/getting-started-publishing.md @@ -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): -- `organizationName`: The GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebookexperimental" 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". +- `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/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`. @@ -60,7 +60,7 @@ GIT_USER= \ > 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. diff --git a/docs/guides-navigation.md b/docs/guides-navigation.md index 54b4b8bde7..4be70019ee 100644 --- a/docs/guides-navigation.md +++ b/docs/guides-navigation.md @@ -110,7 +110,7 @@ Custom links can be added to the site navigation bar with the following entry in ``` headerLinks: [ ... - { href: 'https://github.com/facebookexperimental/Docusaurus', label: 'GitHub' }, + { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' }, ... ], ``` diff --git a/package.json b/package.json index e3b8f71e81..44516ee535 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,7 @@ "version": "1.0.0-beta.15", "repository": { "type": "git", - "url": "https://github.com/facebookexperimental/Docusaurus.git" + "url": "https://github.com/facebook/Docusaurus.git" }, "bin": { "docusaurus-start": "./lib/start-server.js", diff --git a/website/core/Footer.js b/website/core/Footer.js index 2f403ca156..97a40a030f 100644 --- a/website/core/Footer.js +++ b/website/core/Footer.js @@ -41,12 +41,12 @@ class Footer extends React.Component {
More
- + GitHub {showcase}

Are you using this project?

 Add your project diff --git a/website/siteConfig.js b/website/siteConfig.js index d0d59e6b7e..157e2aae25 100644 --- a/website/siteConfig.js +++ b/website/siteConfig.js @@ -50,19 +50,19 @@ const siteConfig = { tagline: "Easy to Maintain Open Source Documentation Websites", url: "https://docusaurus.io", baseUrl: "/", - organizationName: "facebookexperimental", + organizationName: "facebook", projectName: "Docusaurus", cname: "docusaurus.io", noIndex: true, users, editUrl: - "https://github.com/facebookexperimental/docusaurus/edit/master/docs/", + "https://github.com/facebook/docusaurus/edit/master/docs/", headerLinks: [ { doc: "installation", label: "Docs" }, { page: "help", label: "Help" }, { blog: true, label: "Blog" }, { - href: "https://github.com/facebookexperimental/docusaurus", + href: "https://github.com/facebook/docusaurus", label: "GitHub" } ],