Skip to content

Commit b221497

Browse files
authored
Update docu for 3.0.0 release (#518)
* Remove submodule * Replace old hugo theme with maintained * Add example architecture * Update docu to work with new theme * Update docu 3.0.0
1 parent 9701e18 commit b221497

File tree

10 files changed

+1368
-1381
lines changed

10 files changed

+1368
-1381
lines changed

.gitmodules

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
[submodule "docs/themes/hugo-theme-learn"]
2-
path = docs/themes/hugo-theme-learn
3-
url = https://github.com/matcornic/hugo-theme-learn.git
41
[submodule "gogatekeeper.github.io"]
52
path = gogatekeeper.github.io
63
url = git@github.com:gogatekeeper/gogatekeeper.github.io.git
74
[submodule "docs/public"]
85
path = docs/public
96
url = git@github.com:gogatekeeper/gogatekeeper.github.io.git
7+
[submodule "docs/themes/hugo-theme-relearn"]
8+
path = docs/themes/hugo-theme-relearn
9+
url = https://github.com/McShelby/hugo-theme-relearn

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,13 @@ Please remember to provide a good summary, description as well as steps to repro
2222
To run Gatekeeper, you can build it using this command:
2323

2424
```bash
25-
docker buildx build --platform linux/amd64,linux/arm64 -t quay.io/gogatekeeper/gatekeeper:2.14.2 .
25+
docker buildx build --platform linux/amd64,linux/arm64 -t quay.io/gogatekeeper/gatekeeper:3.0.0 .
2626
```
2727

2828
or you can use aleady existing Docker image by running:
2929

3030
```bash
31-
docker run -it --rm quay.io/gogatekeeper/gatekeeper:2.14.2 \
31+
docker run -it --rm quay.io/gogatekeeper/gatekeeper:3.0.0 \
3232
--listen 127.0.0.1:8080 \
3333
--upstream-url http://127.0.0.1:80 \
3434
--discovery-url https://keycloak.example.com/realms/<REALM_NAME> \
@@ -44,16 +44,16 @@ Beside links to archives of binaries we provide also checksum file containing ch
4444
for archives. You can download file gatekeeper-checksum.txt, it contains sha512 checksums e.g.:
4545

4646
```
47-
324b34ece86b6214f835ba9fd79e185864a9005f514458796c22c053de63f428235d2d2a04864065a49c090ad81d2daeb45546544fdd9531a8dea1a43145b8f0 gatekeeper_2.14.2_windows_amd64.zip
48-
38759e75a94d130758cd26958bd9a66b261be8d58a6c7a0fc04845157649aaf628d22a115c95285b405f8e4d6afa8bd78ca8677d1304faf06db93a0cbbc831a6 gatekeeper_2.14.2_linux_amd64.tar.gz
49-
f5322e41b3d78017191246bdd54f99e9b3dd8d5ff9d224e7e81b678a952c1d5aae125ea4c251928969b0a0ea0dc59724308c918993c8227f384f61896f58cbd0 gatekeeper_2.14.2_macOS_amd64.tar.gz
47+
324b34ece86b6214f835ba9fd79e185864a9005f514458796c22c053de63f428235d2d2a04864065a49c090ad81d2daeb45546544fdd9531a8dea1a43145b8f0 gatekeeper_3.0.0_windows_amd64.zip
48+
38759e75a94d130758cd26958bd9a66b261be8d58a6c7a0fc04845157649aaf628d22a115c95285b405f8e4d6afa8bd78ca8677d1304faf06db93a0cbbc831a6 gatekeeper_3.0.0_linux_amd64.tar.gz
49+
f5322e41b3d78017191246bdd54f99e9b3dd8d5ff9d224e7e81b678a952c1d5aae125ea4c251928969b0a0ea0dc59724308c918993c8227f384f61896f58cbd0 gatekeeper_3.0.0_macOS_amd64.tar.gz
5050
```
5151

5252
After you download archive of binary you can calculate it's checksum by using e.g. sha512sum Linux utility:
5353

5454
```
55-
sha512sum /my/path/gatekeeper_2.14.2_linux_amd64.tar.gz
56-
38759e75a94d130758cd26958bd9a66b261be8d58a6c7a0fc04845157649aaf628d22a115c95285b405f8e4d6afa8bd78ca8677d1304faf06db93a0cbbc831a6 gatekeeper_2.14.2_linux_amd64.tar.g
55+
sha512sum /my/path/gatekeeper_3.0.0_linux_amd64.tar.gz
56+
38759e75a94d130758cd26958bd9a66b261be8d58a6c7a0fc04845157649aaf628d22a115c95285b405f8e4d6afa8bd78ca8677d1304faf06db93a0cbbc831a6 gatekeeper_3.0.0_linux_amd64.tar.g
5757
```
5858

5959
As you can see output of command is checksum, you can compare it with the one in gatekeeper-checksum.txt.

docs/config.toml

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ baseURL = "https://gogatekeeper.github.io/gatekeeper"
22
languageCode = "en-us"
33
title = "Gatekeeper"
44

5-
theme = "hugo-theme-learn"
5+
theme = "hugo-theme-relearn"
66

77
[markup]
88
[markup.asciidocExt]
@@ -35,17 +35,15 @@ theme = "hugo-theme-learn"
3535

3636
# For search functionality
3737
[outputs]
38-
home = [ "HTML", "RSS", "JSON"]
38+
home = [ "HTML", "RSS"]
3939

4040
[params]
4141
# Prefix URL to edit current page. Will display an "Edit this page" button on top right hand corner of every page.
4242
# Useful to give opportunity to people to create merge request for your doc.
4343
# See the config.toml file from this documentation site to have an example.
4444
editURL = ""
4545
# Author of the site, will be used in meta information
46-
author = "gogatekeeper"
47-
# Description of the site, will be used in meta information
48-
description = "Gatekeeper's homepage"
46+
author.name = "gogatekeeper"
4947
# Shows a checkmark for visited pages on the menu
5048
showVisitedLinks = false
5149
# Disable search function. It will hide search bar
@@ -65,8 +63,6 @@ disableLandingPageButton = true
6563
disableLanguageSwitchingButton = true
6664
# Hide breadcrumbs in the header and only show the current page title
6765
disableBreadcrumb = false
68-
# If set to true, prevents Hugo from including the mermaid module if not needed (will reduce load times and traffic)
69-
disableMermaid = false
7066
# Specifies the remote location of the mermaid js
7167
customMermaidURL = "https://unpkg.com/mermaid@8.8.0/dist/mermaid.min.js"
7268
# Hide Next and Previous page buttons normally displayed full height beside content

0 commit comments

Comments
 (0)