Skip to content

Commit 611744d

Browse files
authored
docs(infra): Upgrade to Hugo 0.110.0 and Docsy Go module 0.60 (#1807)
* Upgrade to Hugo 0.110.0 Change config.toml to hugo.toml * correct hugo version * comment out markup.highlight, which was needed for mermaid * updated Docsy to Hugo module * remove theme submodule update from netlify.toml config.toml replaced theme with module entry * fix command, add GO_VERSION * added theme mapping to config.yaml So Hugo can find the locally overridden ttheme still local compile error with scss * downgrade bootstrap to 4.6.2 to fix compile error * update readme delete unused files * add github_repo to config to github links work Docsy theme changed "master" to "main" so need to config Add product styles to hide some of the github links * put all config into config.toml Other processes use config.toml and I don't want to break things right now by changing to config.yaml * remove submodule from contribute content
1 parent 723ac89 commit 611744d

File tree

11 files changed

+495
-45
lines changed

11 files changed

+495
-45
lines changed

.gitmodules

-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1 @@
11

2-
[submodule "themes/docsy"]
3-
path = themes/docsy
4-
url = https://github.com/google/docsy

README.md

+6-18
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
This is the repo for Armory documentation site. We welcome contributions from people outside of Armory.
44

5-
The site is hosted by [Netlify](https://www.netlify.com/), which generates a preview build for every pull request. Install [Hugo](https://gohugo.io/) if you want to compile and run the project locally. The Hugo extended version is specified in `netlify.toml` (currently 0.71.1).
5+
The site is hosted by [Netlify](https://www.netlify.com/), which generates a preview build for every pull request. Install the extended version of [Hugo](https://gohugo.io/) (`brew install hugo`) if you want to compile and run the project locally. The Hugo extended version (currently 0.110.10) is specified in both `config.yaml` and `netlify.toml`. Armory docs uses the [Docsy](https://docsy.dev) theme as a Go module. If you want to build locally, you should make sure your workstation has the required software installed. https://www.docsy.dev/docs/get-started/docsy-as-module/installation-prerequisites/
66

7-
The latest version of the docs website is the `master` branch. Previous releases point to branches that start with `release-`.
7+
The latest version of the docs website is the `master` branch. Previous releases point to branches that start with `v`.
88

99
The site has built-in support for [Mermaid](https://mermaid-js.github.io/mermaid/), which is a Javascript based diagramming and charting tool that uses Markdown-inspired text definitions and a renderer to create and modify complex diagrams. <i>Diagramming and documentation costs precious developer time and gets outdated quickly. But not having diagrams or docs ruins productivity and hurts organizational learning. Mermaid addresses this problem by cutting the time, effort and tooling that is required to create modifiable diagrams and charts, for smarter and more reusable content. The text definitions for Mermaid diagrams allows for it to be updated easily, it can also be made part of production scripts (and other pieces of code). So less time needs to be spent on documenting, as a separate and laborious task. Even non-programmers can create diagrams through the Mermaid Live Editor.</i>
1010

@@ -13,9 +13,12 @@ Mermaid resources:
1313
- [Tutorials](https://mermaid-js.github.io/mermaid/getting-started/Tutorials.html)
1414
- [Mermaid Live Editor](https://mermaid-js.github.io/mermaid-live-editor/) - create your diagrams visually and copy the generated Mermaid code to your page
1515

16+
The theme also supports PlantUML and draw.io.
17+
18+
1619
## Cloning the project
1720

18-
If you work for Armory, see the internal docs for how to contribute content.
21+
[Contributor's Guide](https://docs.armory.io/contribute)
1922

2023
People who are not part of the Armory organization need to create a fork of this repo. See the GitHub.com help [docs](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-forks) for how to fork a repo.
2124

@@ -25,13 +28,6 @@ Clone your forked repo:
2528
git clone [email protected]:<github-username>/docs.git
2629
```
2730

28-
Armory docs uses the [Docsy](https://docsy.dev) theme as a submodule. You have to update the submodule if you want to build locally.
29-
30-
```bash
31-
cd docs
32-
git submodule update --init --recursive --depth 1
33-
```
34-
3531
Set this docs repo as the upstream remote:
3632

3733
```bash
@@ -146,14 +142,6 @@ See the GitHub [docs](https://help.github.com/en/github/collaborating-with-issue
146142

147143
**On user-owned forks, select _Allow edits from maintainers_ so maintainers can make changes to your pull request,**
148144

149-
## Troubleshooting
150-
151-
If you run into a situation where the theme says it's been modified but you and the branch you're working on didn't modify the theme (i.e. you run `git status` and see this:https://s.armory.io/4guJmdAq), try updating the submodules:
152-
153-
```bash
154-
git submodule update --init --recursive
155-
```
156-
157145
## Monitoring
158146

159147
The Armory documentation uses New Relic to monitor the website status and other metrics.

assets/scss/_styles_project.scss

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
.td-page-meta--child { display: none !important; }
2+
.td-page-meta--project-issue { display: none !important; }

config-generated.toml

+222
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,222 @@
1+
baseURL = "/"
2+
enableRobotsTXT = true
3+
enableInlineShortcodes = true
4+
enableGitInfo = true
5+
defaultContentLanguage = "en"
6+
defaultContentLanguageInSubdir = false
7+
enableMissingTranslationPlaceholders = true
8+
pygmentsCodeFences = true
9+
pygmentsUseClasses = false
10+
pygmentsUseClassic = false
11+
pygmentsStyle = "tango"
12+
13+
[module]
14+
proxy = "direct"
15+
16+
[module.hugoVersion]
17+
extended = true
18+
min = "0.110.0"
19+
20+
[[module.imports]]
21+
path = "github.com/google/docsy"
22+
disable = false
23+
24+
[[module.imports.mounts]]
25+
source = "assets"
26+
target = "assets"
27+
28+
[[module.imports.mounts]]
29+
source = "node_modules/bootstrap"
30+
target = "assets/vendor/bootstrap"
31+
32+
[[module.imports.mounts]]
33+
source = "node_modules/@fortawesome/fontawesome-free"
34+
target = "assets/vendor/Font-Awesome"
35+
36+
[[module.imports.mounts]]
37+
source = "i18n"
38+
target = "i18n"
39+
40+
[[module.imports.mounts]]
41+
source = "layouts"
42+
target = "layouts"
43+
44+
[[module.imports.mounts]]
45+
source = "static"
46+
target = "static"
47+
48+
[[module.imports.mounts]]
49+
source = "data"
50+
target = "data"
51+
52+
[[module.imports.mounts]]
53+
source = "node_modules/@fortawesome/fontawesome-free/webfonts"
54+
target = "static/webfonts"
55+
56+
[[module.imports]]
57+
path = "github.com/google/docsy/dependencies"
58+
disable = false
59+
60+
[[module.mounts]]
61+
source = "content/en"
62+
target = "content"
63+
64+
[permalinks]
65+
blog = "/:section/:year/:month/:day/:slug/"
66+
67+
[blackfriday]
68+
plainIDAnchors = true
69+
hrefTargetBlank = true
70+
angledQuotes = false
71+
latexDashes = true
72+
73+
[imaging]
74+
resampleFilter = "CatmullRom"
75+
quality = 75
76+
anchor = "smart"
77+
78+
[services.googleAnalytics]
79+
id = "UA-79996712-5"
80+
81+
[languages.en]
82+
description = "Commit. Deploy. Repeat. Continuous Deployment at any scale, for all developers."
83+
languageName = "English"
84+
weight = 1
85+
86+
[markup.goldmark.renderer]
87+
unsafe = true
88+
89+
[[menu.main]]
90+
name = "CD-as-a-Service"
91+
weight = 2
92+
url = "/cd-as-a-service/"
93+
94+
[[menu.main]]
95+
name = "Armory CD"
96+
weight = 3
97+
url = "/continuous-deployment/"
98+
99+
[[menu.main]]
100+
name = "Scale Agent"
101+
weight = 4
102+
url = "/scale-agent/"
103+
104+
[[menu.main]]
105+
name = "Support"
106+
weight = 5
107+
url = "https://support.armory.io/"
108+
109+
[[menu.main]]
110+
name = "Blog"
111+
weight = 6
112+
url = "https://www.armory.io/blog/"
113+
114+
[[menu.main]]
115+
name = "Armory.io"
116+
weight = 7
117+
url = "https://www.armory.io/"
118+
119+
[[menu.main]]
120+
name = "Contribute"
121+
weight = 10
122+
url = "/contribute/"
123+
124+
[params]
125+
deploy-engine-plugin-version = "0.16.8"
126+
armory-version = "2.28.x"
127+
matching-oss-version-exact = "1.27.0"
128+
mysql-version = "5.7; AWS Aurora"
129+
postgresql-version = "10+"
130+
armory-version-exact = "2.28.0"
131+
halyard-armory-version = "1.12.1"
132+
kubesvc-version = "1.0.33"
133+
operator-extended-crd-version = "v1alpha2"
134+
operator-oss-crd-version = "v1alpha2"
135+
opa-server-version = "0.28.0"
136+
copyright = "Armory Inc."
137+
privacy_policy = "https://www.armory.io/privacy-policy/"
138+
terms_of_service = "https://www.armory.io/terms-of-service/"
139+
terms_and_conditions = "https://www.armory.io/terms-and-conditions/"
140+
cdaas_banner = false
141+
version_menu = "Armory CD v2.28"
142+
archived_version = false
143+
version = "2.28.0"
144+
url_latest_version = "https://docs.armory.io/continuous-deployment/"
145+
github_repo = "https://github.com/armory/docs/"
146+
github_branch = "master"
147+
algolia_docsearch = false
148+
offlineSearch = true
149+
offlineSearchMaxResults = 50
150+
offlineSearchSummaryLength = 200
151+
prism_syntax_highlighting = true
152+
153+
[params.kubesvc-plugin]
154+
agent_plug_latest-3 = "0.8.66"
155+
agent_plug_latest_spin-3 = "2.25.x (1.25.x)"
156+
agent_plug_latest-2 = "0.9.81"
157+
agent_plug_latest_spin-2 = "2.26.x (1.26.x)"
158+
agent_plug_latest-1 = "0.10.65"
159+
agent_plug_latest_spin-1 = "2.27.x (1.27.x)"
160+
agent_plug_latest = "0.11.27"
161+
agent_plug_latest_spin = "2.28.x (1.28.x)"
162+
163+
[params.ui]
164+
sidebar_menu_compact = true
165+
sidebar_menu_foldable = true
166+
sidebar_cache_limit = 10
167+
breadcrumb_disable = false
168+
sidebar_search_disable = false
169+
navbar_logo = true
170+
footer_about_disable = false
171+
172+
[params.ui.feedback]
173+
enable = true
174+
yes = "Thank you for letting us know!"
175+
no = 'Sorry to hear that. Please <a href="https://github.com/armory/docs/issues/new">tell us how we can improve</a>.'
176+
177+
[params.ui.readingtime]
178+
enable = false
179+
180+
[params.mermaid]
181+
theme = "forest"
182+
enable = true
183+
184+
[[params.links.user]]
185+
name = "Email Armory"
186+
url = "mailto:[email protected]"
187+
icon = "fa fa-envelope"
188+
desc = "Discussion and help from your fellow users"
189+
190+
[[params.links.user]]
191+
name = "Twitter"
192+
url = "https://twitter.com/cloudarmory"
193+
icon = "fab fa-twitter"
194+
desc = "Follow us on Twitter to get the latest news!"
195+
196+
[[params.links.user]]
197+
name = "RSS"
198+
url = "https://docs.armory.io/index.xml"
199+
icon = "fas fa-rss"
200+
desc = "Follow us on RSS to get the latest docs updates!"
201+
202+
[[params.links.developer]]
203+
name = "GitHub"
204+
url = "https://github.com/armory/docs/"
205+
icon = "fab fa-github"
206+
desc = "Docs repository"
207+
208+
[[params.links.developer]]
209+
name = "Slack"
210+
url = "https://join.spinnaker.io/"
211+
icon = "fab fa-slack"
212+
desc = "Chat with Armory users and developers in the Spinnaker Slack"
213+
214+
[[params.versions]]
215+
version = "Armory CD v2.27"
216+
githubbranch = "v2.27"
217+
url = "https://v2-27.docs.armory.io/docs/"
218+
219+
[[params.versions]]
220+
version = "Armory CD v2.26"
221+
githubbranch = "v2.26"
222+
url = "https://v2-26.docs.armory.io/docs/"

0 commit comments

Comments
 (0)