Skip to content

Commit

Permalink
docs: update local devcontainer setup
Browse files Browse the repository at this point in the history
  • Loading branch information
thekaveman committed Sep 15, 2023
1 parent 5744e33 commit 731f26d
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 14 deletions.
16 changes: 8 additions & 8 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,17 @@ published online at `https://docs.calitp.org/repo-name`.

Adapted from [GitHub's documentation][gh-template-repo-howto].

1. Head to the *generate repository* page for this template:
<https://github.com/cal-itp/mkdocs-template/generate>
1. Head to the _generate repository_ page for this template:
<https://github.com/cal-itp/mkdocs-template/generate>

1. Configure the new repository's details, including the **Owner** (`cal-itp`), **Name**, and **Description**
![Screenshot showing creating a new repository from mkdocs-template](img/new-repo-init.png)
![Screenshot showing creating a new repository from mkdocs-template](img/new-repo-init.png)

1. Ensure the new repository's visiblity is set to **Public**
![Screenshot showing the new repository's visibility set to Public](img/new-repo-visibility.png)
![Screenshot showing the new repository's visibility set to Public](img/new-repo-visibility.png)

1. Ensure the checkbox to **Include all branches** is checked
![Screenshot showing the Include all branches checkbox checked](img/new-repo-all-branches.png)
![Screenshot showing the Include all branches checkbox checked](img/new-repo-all-branches.png)

1. Click **Create repository from template** to finish and create the new repository

Expand All @@ -30,10 +30,10 @@ Once the above steps are complete and the new repository is ready, it's a good i

This includes:

* **Review** the `LICENSE` file and ensure it is appropriate for your new project. If not, update it with a more appropriate
- **Review** the `LICENSE` file and ensure it is appropriate for your new project. If not, update it with a more appropriate
license before continuing.
* **Find+Replace** instances of `mkdocs-template` with the name of your new repository.
* **Edit** the `docs/.pages` file to update your site's navigation menu, or delete the file to generate a navigation menu for the
- **Find+Replace** instances of `mkdocs-template` with the name of your new repository.
- **Edit** the `docs/.pages` file to update your site's navigation menu, or delete the file to generate a navigation menu for the
site automatically. Read more about the
[`mkdocs-awesome-pages-plugin`](https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin/#customize-navigation).

Expand Down
18 changes: 12 additions & 6 deletions docs/running-locally.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ cd mkdocs-template
## Build the image

```bash
docker build -t mkdocs-template -f docs/Dockerfile .
docker build -t mkdocs-template -f .devcontainer/Dockerfile .
```

## Run a container
Expand All @@ -24,12 +24,18 @@ docker run -p 8000:8000 mkdocs-template

The site should be available at <http://localhost:8000>.

## VS Code Remote Containers
## VS Code Devcontainer

This repository comes with a [VS Code Remote Containers](https://code.visualstudio.com/docs/remote/containers)
configuration file.
This repository comes with a [VS Code Devcontainers](https://code.visualstudio.com/docs/remote/containers) configuration.

Once you clone the repository locally, simply open it within VS Code, which will
prompt you to re-open the repository within the Remote Container.
prompt you to re-open the repository within the Devcontainer.

Once running inside the Remote Container, the site is available at <http://localhost:8000>.
Once the Devcontainer is running, bring up the Command Palette and enter:

```console
> Tasks: Run Build Task
```

To build the site and launch a local server. The site is running on <http://localhost> at a randomly assigned port; see the
VS Code `Ports` tab for information.

0 comments on commit 731f26d

Please sign in to comment.