Skip to content

Commit 02b163b

Browse files
authored
docs(infra): Upgrade Docsy to 0.7.1; Remove Prism (#2104)
* docs(infra): Remove Prism; Upgrade Docsy DOC-738 DOC-725 * fix link to CD-as-a-Service plugin in included table * change highlight to backticks if no actual lines highlighted rendered highlight shortcode doesn't have code copy button * update layout pages from latest theme * change guessSyntax to true so rego code blocks render with black background
1 parent 525a0c0 commit 02b163b

File tree

72 files changed

+348
-1060
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

72 files changed

+348
-1060
lines changed

config.toml

+27-11
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,41 @@ googleAnalytics = 'G-W14B82N2D2'
2121

2222
#disableKinds = ["taxonomy", "taxonomyTerm"]
2323

24-
# Highlighting config
24+
# Highlighting config (copied from the docsy example site, tag v0.7.1)
2525
pygmentsCodeFences = true
2626
pygmentsUseClasses = false
2727
# Use the new Chroma Go highlighter in Hugo.
2828
pygmentsUseClassic = false
2929
#pygmentsOptions = "linenos=table"
3030
# See https://help.farbox.com/pygments.html
31-
pygmentsStyle = "tango"
31+
pygmentsStyle = "dracula"
32+
33+
[markup]
34+
[markup.goldmark]
35+
[markup.goldmark.parser.attribute]
36+
block = true
37+
[markup.goldmark.renderer]
38+
unsafe = true
39+
[markup.highlight]
40+
# See a complete list of available styles at https://xyproto.github.io/splash/docs/all.html
41+
style = "dracula"
42+
# these are defaults https://gohugo.io/getting-started/configuration-markup/#highlight
43+
anchorLineNos = false
44+
codeFences = true
45+
hl_Lines = ''
46+
hl_inline = false
47+
lineAnchors = ''
48+
lineNoStart = 1
49+
lineNos = false
50+
lineNumbersInTable = true
51+
noClasses = true
52+
noHl = false
53+
tabWidth = 4
54+
guessSyntax = true
55+
# Set guessSyntax to true if you want your chosen highlight style used for code blocks without a specified language
3256

3357
# Docsy is now a Go module; need to map theme dirs to local dirs
58+
# 16 Aug 2023 When I remove the module.imports.mounts entries, compilation breaks with a lot of "not found" - can't find shortcodes or refs
3459
[module]
3560
proxy = "direct"
3661

@@ -112,11 +137,6 @@ languageName ="English"
112137
# Weight used for sorting.
113138
weight = 1
114139

115-
[markup]
116-
[markup.goldmark]
117-
[markup.goldmark.renderer]
118-
unsafe = true
119-
120140
[[menu.main]]
121141
name = "CD-as-a-Service"
122142
weight = 2
@@ -156,7 +176,6 @@ weight = 1
156176

157177
[params]
158178
# See codenew shortcode
159-
githubWebsiteRaw = "raw.githubusercontent.com/armory/docs"
160179
deploy-engine-plugin-version = "0.16.8"
161180
armory-version = "2.30.x"
162181
#used in air-gapped
@@ -220,9 +239,6 @@ offlineSearch = true
220239
offlineSearchMaxResults = 50
221240
offlineSearchSummaryLength = 200
222241

223-
# Enable syntax highlighting and copy buttons on code blocks with Prism
224-
prism_syntax_highlighting = true
225-
226242
# Armory Agent plugin versions
227243
[params.kubesvc-plugin]
228244

content/en/continuous-deployment/armory-admin/generating-certificates.md

+4-5
Original file line numberDiff line numberDiff line change
@@ -94,8 +94,7 @@ The following script generates these files in the `services` directory:
9494
- Certificate and key files for each Golang services (`terraformer.crt` and `terraformer.key`, ...)
9595
- a `tls-passwords` file containing all the passwords. You can store as-is in a bucket.
9696

97-
98-
{{< prism lang="shell" line-numbers="true" >}}
97+
```shell
9998
#!/bin/bash -e
10099

101100
# You can change it to a different method
@@ -172,12 +171,12 @@ EOF
172171
173172
echo "${svc}: ${password}" >> services/tls-passwords
174173
done
175-
{{< /prism >}}
174+
```
176175
177176
## Troubleshooting
178177
179178
You may encounter the following error if the version of Java you are using to generate the certificates is not the same version that Armory Continuous Deployment is using:
180179
181-
{{< prism lang="shell" >}}
180+
```bash
182181
java.io.IOException: Integrity check failed: java.security.NoSuchAlgorithmException: Algorithm HmacPBESHA256 not available
183-
{{< /prism >}}
182+
```

content/en/continuous-deployment/armory-admin/observe/integrations-logging.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ The following configuration example shows how to configure Echo to send data to
2525

2626
Add the <b>rest</b> block to the <b>spec.spinnakerConfig.profiles.echo</b> section of your Operator manifest.
2727

28-
{{< prism lang="yaml" >}}
28+
```yaml
2929
apiVersion: spinnaker.armory.io/v1alpha2
3030
kind: SpinnakerService
3131
metadata:
@@ -43,7 +43,7 @@ spec:
4343
Authorization: "<TOKEN>"
4444
template: '{"event":{{event}} }'
4545
insecure: true
46-
{{< /prism >}}
46+
```
4747
4848
4949
* `SERVICE_URL`: the FQDN of the service; for example `https://splunk.armory.io`.

content/en/continuous-deployment/armory-admin/observe/observability-configure.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ You have two options for installing the Observability plugin:
3131

3232
The following example adds the Observability Plugin configuration for all services to the `spinnaker-local.yml` file and enables Prometheus:
3333

34-
{{< prism lang="yaml" >}}
34+
```yaml
3535
# These lines are spring-boot configuration to allow access to the metrics
3636
# endpoints. This plugin adds the "aop-prometheus" endpoint on the
3737
# "<service>:<port>/aop-prometheus" path.
@@ -54,6 +54,6 @@ spinnaker:
5454
repositories:
5555
armory-observability-plugin-releases:
5656
url: https://raw.githubusercontent.com/armory-plugins/armory-observability-plugin-releases/master/repositories.json
57-
{{< /prism >}}
57+
```
5858
5959
You can find more options for management endpoints and the plugin in the [plugin's README](https://github.com/armory-plugins/armory-observability-plugin).

content/en/continuous-deployment/installation/armory-operator/op-advanced-config.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ For example, to ensure that a `ConfigMap` is present on all Spinnaker services,
8383
you would add the following configuration block to your `SpinnakerService`
8484
config:
8585

86-
{{< prism lang="yaml" line="5-9" >}}
86+
{{< highlight yaml "linenos=table,hl_lines=5-9" >}}
8787
apiVersion: spinnaker.armory.io/v1alpha2
8888
kind: SpinnakerService
8989
metadata:
@@ -105,7 +105,7 @@ spec:
105105
mountPath: /opt/spinnaker/config/foo
106106
type: configMap
107107
name: custom-volume
108-
{{< /prism >}}
108+
{{< /highlight >}}
109109

110110
The previous configuration sample indicates how to specify patches in the
111111
[`patchesJson6902`

content/en/continuous-deployment/installation/armory-operator/op-config-kustomize.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -100,15 +100,15 @@ version](https://spinnaker.io/community/releases/versions/) that you want to
100100
deploy, such as `{{< param "armory-version-exact" >}}` (Armory Continuous Deployment) or
101101
`1.25.3` (Spinnaker).
102102

103-
{{< prism lang="yaml" line="8" >}}
103+
{{< highlight yaml "linenos=table,hl_lines=8" >}}
104104
kind: SpinnakerService
105105
metadata:
106106
name: spinnaker
107107
spec:
108108
spinnakerConfig:
109109
config:
110110
version: {{< param "armory-version-exact" >}}
111-
{{< /prism >}}
111+
{{< /highlight >}}
112112

113113
### Verify resources
114114

content/en/continuous-deployment/installation/armory-operator/op-config-manifest.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ description: >
2020

2121
The structure of the manifest file is the same whether you are using the Armory Operator or the Spinnaker Operator. The value of certain keys, though, depends on whether you are deploying Armory Continuous Deployment or Spinnaker. The following snippet is the first several lines from a `spinnakerservice.yml` manifest that deploys Armory Continuous Deployment.
2222

23-
{{< prism lang="yaml" line="1,8" >}}
23+
{{< highlight yaml "linenos=table,hl_lines=1 8" >}}
2424
apiVersion: spinnaker.armory.io/{{< param "operator-extended-crd-version" >}}
2525
kind: SpinnakerService
2626
metadata:
@@ -34,7 +34,7 @@ spec:
3434
s3:
3535
bucket: <s3-bucket-name>
3636
rootFolder: front50
37-
{{< /prism >}}
37+
{{< /highlight >}}
3838

3939
* Line 1: `apiVersion` is the CRD version of the `SpinnakerService` custom resource.
4040
* If you are deploying Armory Continuous Deployment, the value is `spinnaker.armory.io/{{< param "operator-extended-crd-version" >}}`; if you change this value, the Armory Operator won't process the manifest file.

content/en/continuous-deployment/installation/guide/air-gapped/ag-operator.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ Each subdirectory in the `profiles` directory contains a `<service-name>.yml` pr
144144

145145
If you need to change your Docker registry, you can manually edit the `<armory-version>.yml` file located under `halconfig/bom`. Update the value for the key `artifactSources.dockerRegistry`.
146146

147-
{{< prism lang="yaml" line="18" >}}
147+
{{< highlight yaml "linenos=table,hl_lines=18" >}}
148148
version: 2.25.0
149149
timestamp: "2021-03-25 09:28:32"
150150
services:
@@ -163,7 +163,7 @@ dependencies:
163163
version: 2:2.8.4-2
164164
artifactSources:
165165
dockerRegistry: my.jfrog.io/myteam/armory
166-
{{< /prism >}}
166+
{{< /highlight >}}
167167

168168
## Copy the BOM
169169

@@ -257,7 +257,7 @@ From the `spinnaker-kustomize-patches/operator` folder, execute the `operatorima
257257
You also need to update Armory Operator configuration to include the secret access key for MinIO.
258258
Locate `spinnaker-kustomize-patches/operator/patch-config.yml` and update the `AWS_SECRET_ACCESS_KEY` value with the `minioAccessKey` value you created in the [Deploy MinIO to host the BOM](#deploy-minio-to-host-the-bom) section.
259259

260-
{{< prism lang="yaml" line="14, 24" >}}
260+
{{< highlight yaml "linenos=table,hl_lines=14 24" >}}
261261
apiVersion: apps/v1
262262
kind: Deployment
263263
metadata:
@@ -291,13 +291,13 @@ spec:
291291
defaultMode: 420
292292
name: operator-config
293293
name: operator-config
294-
{{< /prism >}}
294+
{{< /highlight >}}
295295

296296
### Update Halyard configuration
297297

298298
The Armory Operator uses its own Halyard installation to deploy and manage Armory Continuous Deployment. You need to configure the new BOM location in `spinnaker-kustomize-patches/operator/halyard-local.yml`. Update your `halyard-local.yml` to match the content of the highlighted lines in the following example:
299299

300-
{{< prism lang="yaml" line="8-14" >}}
300+
{{< highlight yaml "linenos=table,hl_lines=8-14" >}}
301301
halyard:
302302
halconfig:
303303
directory: /home/spinnaker/.hal
@@ -312,7 +312,7 @@ spinnaker:
312312
enablePathStyleAccess: true # If you are using a platform that does not support PathStyleAccess, such as MinIO, switch this to true (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro).
313313
endpoint: http://minio.spinnaker:9000
314314
anonymousAccess: false
315-
{{< /prism >}}
315+
{{< /highlight >}}
316316

317317

318318
## Deploy the Armory Operator

content/en/contribute/create/guides/diagram-guide.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ title: Diagram Guide
33
weight: 3
44
description: >
55
Use Mermaid to create diagrams and charts in your content pages.
6+
draft: true
67
---
78

89
## {{% heading "prereq" %}}
@@ -58,7 +59,7 @@ Additional Mermaid resources:
5859
```
5960

6061
<details><summary>Show me the code.</summary>
61-
{{< prism >}}
62+
{{< highlight >}}
6263
```mermaid
6364
graph TB
6465
@@ -95,7 +96,7 @@ Additional Mermaid resources:
9596
classDef external fill:#c0d89d,stroke:#39546a;
9697
class deck,api external
9798
```
98-
{{< /prism >}}
99+
{{< /highlight >}}
99100
</details>
100101

101102
### Flowchart examples
@@ -126,7 +127,7 @@ flowchart LR
126127
```
127128

128129
<details><summary>Show me the code.</summary>
129-
{{< prism >}}
130+
{{< highlight >}}
130131
```mermaid
131132
flowchart LR
132133
id0<--"REST API"-->id2
@@ -151,7 +152,7 @@ flowchart LR
151152
class id2,id3,id0 armory
152153
class outside ext
153154
```
154-
{{< /prism >}}
155+
{{< /highlight >}}
155156
</details>
156157

157158
<br>
@@ -182,7 +183,7 @@ flowchart TB
182183
```
183184

184185
<details><summary>Show me the code.</summary>
185-
{{< prism >}}
186+
{{< highlight >}}
186187
```mermaid
187188
flowchart TB
188189
A --> B
@@ -205,7 +206,7 @@ flowchart TB
205206
E[Callback to Deployment]
206207
end
207208
```
208-
{{< /prism >}}
209+
{{< /highlight >}}
209210
</details>
210211

211212

content/en/contribute/create/guides/docs-style-guide.md

-5
Original file line numberDiff line numberDiff line change
@@ -411,8 +411,3 @@ When in doubt, check the company’s website.
411411
| Elastic Compute Cloud | EC2 | Spinnaker can deploy EC2 instances after baking an AMI for them. |
412412
| NGINX, NGINX Plus, NGINX Controller| | |
413413
414-
415-
## {{% heading "nextSteps" %}}
416-
417-
{{< linkWithTitle "diagram-guide.md" >}}
418-
<br><br>

content/en/contribute/create/guides/prism.md

-71
This file was deleted.

0 commit comments

Comments
 (0)