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.

Sign up for GitHub

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

Containerized user guides #557

Merged
merged 2 commits into from
Mar 7, 2024
Merged

Containerized user guides #557

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9e0c9d3
Apply minor formatting changes to general content guide
Rene2mt Dec 21, 2023
118dcbe
Add support for running containerized guides site locally
Rene2mt Jan 30, 2024
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 docker-compose.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
version : '3'
services:
hugo:
image: klakegg/hugo:0.107.0-ext-alpine
command: server -s /fedramp-automation/docs --enableGitInfo=false --minify
volumes:
- ".:/fedramp-automation"
ports:
- "1313:1313"
11 changes: 4 additions & 7 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The website is built using the [Hugo](https://gohugo.io/) static site generator

If using Docker:

- [Docker 20.10+](https://docs.docker.com/install/)
- [Docker 23.0+](https://docs.docker.com/get-docker/)

If not using Docker:

Expand Down Expand Up @@ -70,17 +70,14 @@ Whenever you make any changes to the content with the Hugo server running, you'l

## Developing with Docker

Coming soon: The site will be available as a Docker container.

<!--
The website can also be developed and built using the included Docker resources.

Assuming you've [installed Docker](https://docs.docker.com/install/) and [Docker Compose](https://docs.docker.com/compose/install/) for your system, you can build and serve the site using Docker Compose as follows:
Assuming you've [installed Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) for your system, you can build and serve the site using Docker Compose as follows:

```
docker-compose build
docker-compose up
```

Once the site is running, it can be accessed at http://localhost:1313/fedramp-automation.
-->
Once the site is running, it can be accessed at [http://localhost:1313/](http://localhost:1313/).

Loading
Loading