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

docs: normalized spelling of web server #1473

Merged
merged 1 commit into from
May 17, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/getting-started-docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ title: Docker

[Docker](https://www.docker.com/) is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

## Run the local webserver in docker
## Run the local web server in docker

Ensure you have previously installed [docker](https://www.docker.com/get-started).

To run the local webserver:
To run the local web server:

1. **Build the docker image** -- Enter the folder where you have Docusaurus installed. Run `docker build -t docusaurus-doc .`

Expand All @@ -23,7 +23,7 @@ To run the local webserver:

## Use docker-compose

We can also use `docker-compose` to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.
We can also use `docker-compose` to configure our application. This feature of docker allows you to run the web server and any additional services with a single command.

> Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.

Expand Down Expand Up @@ -58,6 +58,6 @@ services:

```

To run a local webserver with `docker-compose` run `docker-compose up`.
To run a local web server with `docker-compose` run `docker-compose up`.

To build static HTML pages for publishing run `docker-compose run docusaurus bash -c 'yarn publish-gh-pages'`
2 changes: 1 addition & 1 deletion docs/getting-started-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ described in the [Installation](#installing-docusaurus) section, you will have a
runnable, example website to use as your site's base. To run:

1. `cd website`
1. From within the `website` directory, run the local webserver using
1. From within the `website` directory, run the local web server using
`yarn start` or `npm start`.
1. Load the example site at http://localhost:3000 if it did not already open
automatically. If port 3000 has already been taken, another port will be used. Look at the console messages to see which.
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial-create-pages.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ I can write content using [GitHub-flavored Markdown syntax](https://github.githu
}
```

4. Kill your webserver (<kbd>Cmd</kbd> + <kbd>C</kbd> or <kbd>Ctrl</kbd> + <kbd>C</kbd>) and restart it (with `npm run start`) because a server restart is needed for sidebar changes.
4. Kill your web server (<kbd>Cmd</kbd> + <kbd>C</kbd> or <kbd>Ctrl</kbd> + <kbd>C</kbd>) and restart it (with `npm run start`) because a server restart is needed for sidebar changes.
5. Navigate to http://localhost:3000/docs/doc4.

You've created your first documentation page on Docusaurus! The `sidebars.json` is where you specify the order of your documentation pages and in the front matter of the Markdown file is where you provide metadata about that page.
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial-publish-site.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Next we'll learn how to publish the site to the WWW for everyone to browse! For

## Put the Site Online

Kill the webserver first by pressing Cmd + C or Ctrl + C depending on your operating system.
Kill the web server first by pressing Cmd + C or Ctrl + C depending on your operating system.

In `website/siteConfig.js`, fill in the following fields:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Running the Docusaurus initialization script, `docusaurus-init`, produces a runn
1. In your root, rename `docs-examples-from-docusaurus` to `docs`.
1. `cd website`
1. Rename `blog-examples-from-docusaurus` to `blog`.
1. Run the local webserver via `yarn start` or `npm start`.
1. Run the local web server via `yarn start` or `npm start`.
1. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser.

![](/img/getting-started-preparation-verify.png)
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Running the Docusaurus initialization script, `docusaurus-init`, produces a runn
1. In your root, rename `docs-examples-from-docusaurus` to `docs`.
1. `cd website`
1. Rename `blog-examples-from-docusaurus` to `blog`.
1. Run the local webserver via `yarn start` or `npm start`.
1. Run the local web server via `yarn start` or `npm start`.
1. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser.

![](/img/getting-started-preparation-verify.png)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Running the Docusaurus initialization script, `docusaurus-init`, produces a runn
1. In your root, rename `docs-examples-from-docusaurus` to `docs`.
1. `cd website`
1. Rename `blog-examples-from-docusaurus` to `blog`.
1. Run the local webserver via `yarn start` or `npm start`.
1. Run the local web server via `yarn start` or `npm start`.
1. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the `website` directory will cause the page to refresh.

![](/img/getting-started-preparation-verify.png)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ runnable, example website to use as your site's base. To run:
1. In your root, rename `docs-examples-from-docusaurus` to `docs`.
1. `cd website`
1. Rename `blog-examples-from-docusaurus` to `blog`.
1. From within the `website` directory, run the local webserver using
1. From within the `website` directory, run the local web server using
`yarn start` or `npm start`.
1. Load the example site at http://localhost:3000 if it did not already open
automatically.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ original_id: docker

[Docker](https://www.docker.com/) is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

## Run the local webserver in docker
## Run the local web server in docker

Ensure you have previously installed [docker](https://www.docker.com/get-started).

To run the local webserver:
To run the local web server:

1. **Build the docker image** -- Enter the folder where you have Docusaurus installed. Run `docker build -t docusaurus-doc .`

Expand All @@ -24,7 +24,7 @@ To run the local webserver:

## Use docker-compose

We can also use `docker-compose` to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.
We can also use `docker-compose` to configure our application. This feature of docker allows you to run the web server and any additional services with a single command.

> Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.

Expand Down Expand Up @@ -59,6 +59,6 @@ services:

```

To run a local webserver with `docker-compose` run `docker-compose up`.
To run a local web server with `docker-compose` run `docker-compose up`.

To build static HTML pages for publishing run `docker-compose run docusaurus bash -c 'yarn publish-gh-pages'`
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ runnable, example website to use as your site's base. To run:
1. In your root, rename `docs-examples-from-docusaurus` to `docs`.
1. `cd website`
1. Rename `blog-examples-from-docusaurus` to `blog`.
1. From within the `website` directory, run the local webserver using
1. From within the `website` directory, run the local web server using
`yarn start` or `npm start`.
1. Load the example site at http://localhost:3000 if it did not already open
automatically.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ runnable, example website to use as your site's base. To run:
1. In your root, rename `docs-examples-from-docusaurus` to `docs`.
1. `cd website`
1. Rename `blog-examples-from-docusaurus` to `blog`.
1. From within the `website` directory, run the local webserver using
1. From within the `website` directory, run the local web server using
`yarn start` or `npm start`.
1. Load the example site at http://localhost:3000 if it did not already open
automatically.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ described in the [Installation](#installing-docusaurus) section, you will have a
runnable, example website to use as your site's base. To run:

1. `cd website`
1. From within the `website` directory, run the local webserver using
1. From within the `website` directory, run the local web server using
`yarn start` or `npm start`.
1. Load the example site at http://localhost:3000 if it did not already open
automatically. If port 3000 has already been taken, another port will be used. Look at the console messages to see which.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ In this session, we learned how Docusaurus makes it really simple to create a we
}
```

4. Kill your webserver (<kbd>Cmd</kbd> + <kbd>C</kbd> or <kbd>Ctrl</kbd> + <kbd>C</kbd>) and restart it (with `npm run start`) because a server restart is needed for sidebar changes.
4. Kill your web server (<kbd>Cmd</kbd> + <kbd>C</kbd> or <kbd>Ctrl</kbd> + <kbd>C</kbd>) and restart it (with `npm run start`) because a server restart is needed for sidebar changes.
5. Navigate to http://localhost:3000/docs/f8.

You've created your first documentation page on Docusaurus! The `sidebars.json` is where you specify the order of your documentation pages and in the front matter of the Markdown file is where you provide metadata about that page.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Next we'll learn how to publish the site to the WWW for everyone to browse! For

## Put the Site Online

Kill the webserver first by pressing Cmd + C or Ctrl + C depending on your operating system.
Kill the web server first by pressing Cmd + C or Ctrl + C depending on your operating system.

In `website/siteConfig.js`, fill in the following fields:

Expand Down