Skip to content

Commit

Permalink
Merge pull request #12 from gbraad-redhat/main
Browse files Browse the repository at this point in the history
Improvements to README and add gvproxy excalidraw
  • Loading branch information
gbraad authored Dec 5, 2024
2 parents 36217dd + 89f85c1 commit c567376
Show file tree
Hide file tree
Showing 3 changed files with 1,051 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,23 @@ You can open this repo on GitHub to read, use the GitHub Pages for a published v
For example, it is easy to use `.` to start the GitHub Web Editor to read and edit these files.


## Build instructions
### Build using container
To create the HTML output, you can use:

```
$ podman run --rm -v $PWD:/workspace quay.io/crc-org/mdbook:0.4.43 build
```

This will create a `book` folder that contains the output for a static webpage like GitHub Pages.


### Devcontainer
You can also use the devcontainer setup. This will start the generation container and allows you to use the `mdbook` command line directly from inside the editor.

This can be started from CodeSpaces, VS Code or the CLI
```shell
$ npm install -g @devcontainers/cli
$ devcontainer up --workspace-folder .
```

After the container has been started, you can use `mdbook build` to generate the output, and `mdbook serve` to open a preview using the forward of port 3000.
5 changes: 5 additions & 0 deletions content/Usermode-networking-stack.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,3 +65,8 @@ On Windows, this is slightly more complicated. Please follow this guide:

> [!CAUTION]
> Don't run Docker Desktop with Kubernetes activated and CRC side-by-side. This might lead to overlapping of ports.

## Technical details

![gvproxy](kroki-excalidraw:./assets/gvproxy.excalidraw)
Loading

0 comments on commit c567376

Please sign in to comment.