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

Add Docker to run docsy user guide locally #1016

Merged
merged 2 commits into from
Jun 13, 2022
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
9 changes: 9 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
FROM klakegg/hugo:0.95.0-ext-alpine as docsy-user-guide

RUN apk update
RUN apk add git
COPY package.json /app/docsy/userguide/
WORKDIR /app/docsy/userguide/
RUN npm install --production=false

CMD ["serve", "--cleanDestinationDir", "--themesDir ../..", "--baseURL http://localhost:1313/", "--buildDrafts", "--buildFuture", "--disableFastRender", "--ignoreCache", "--watch"]
14 changes: 14 additions & 0 deletions docker-compose.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
version: "3.3"

services:

site:
image: docsy/user-guide
build:
context: .
ports:
- "1313:1313"
user: "${DOCSY_USER}"
volumes:
- /app/docsy/userguide/node_modules
- .:/app/docsy
45 changes: 45 additions & 0 deletions userguide/content/en/docs/Contribution guidelines/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,51 @@ If you want to run your own local Hugo server to preview your changes as you wor
1. Continue with the usual GitHub workflow to edit files, commit them, push the
changes up to your fork, and create a pull request.

#### Preview your changes using a Docker container

Docsy comes with `Dockerfile` and `docker-compose` files to run the server
locally with Docker, without installing any additional dependencies.

- Using [Docker]:

1. Build the Docker container:

```bash
docker build -t docsy/user-guide
```

1. Run the container, mounting the repository as a shared volume:

```bash
docker run -it --user=$(id -u):$(id -g) -p 1313:1313 \
-v $(pwd):/app/docsy -v /app/docsy/userguide/node_modules \
docsy/user-guide
```

- Using [Docker Compose][docker-compose]:

1. Build the container:

```bash
docker-compose build
```

1. Run the container:

```bash
DOCSY_USER=$(id -u):$(id -g) docker-compose up
```

Open `http://localhost:1313` in your web browser to load the docsy user guide.
In most cases, docsy will automatically reload the site to reflect any changes
to the documentation or the code. Changes to some parts of the docsy code may
require manually reloading the page or re-starting the container.

Press **Ctrl + C** to stop the container.

[docker]: https://docs.docker.com/get-docker/
[docker-compose]: https://docs.docker.com/compose/install/

### Creating an issue

If there's something you'd like to see in the docs, but you're not sure how to fix it yourself, please create an issue in [this repository](https://github.com/google/docsy). You can also create an issue about a specific page by clicking the **Create Issue** button in the top right hand corner of the page.
Expand Down