Skip to content

Commit 3d41ccd

Browse files
a-velascopaulomach
andauthored
Fix spelling, broken links, and navigation issues (#666)
* fix toctrees and landing pages * fix spelling and link errors * add doc ci workflow * small fixes * remove update script * Add mysql.com domains to linkcheck ignore * generalize azure portal url to ignore in linkcheck * remove emojis and discourse underline notation * update contacts page * Update docs/how-to/development/migrate-data-via-backup-restore.md Co-authored-by: Paulo Machado <[email protected]> * update legacy charm warning --------- Co-authored-by: Paulo Machado <[email protected]>
1 parent b741336 commit 3d41ccd

Some content is hidden

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

62 files changed

+309
-618
lines changed
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
#
2+
name: Automatic doc checks
3+
4+
on:
5+
push:
6+
branches: [ main ]
7+
pull_request:
8+
paths:
9+
- 'docs/**' # Only run on changes to the docs directory
10+
11+
workflow_dispatch:
12+
# Manual trigger
13+
14+
15+
concurrency:
16+
group: ${{ github.workflow }}-${{ github.ref }}
17+
cancel-in-progress: true
18+
19+
jobs:
20+
documentation-checks:
21+
uses: canonical/documentation-workflows/.github/workflows/documentation-checks.yaml@main
22+
with:
23+
working-directory: "docs"
24+
fetch-depth: 0

docs/.custom_wordlist.txt

Lines changed: 34 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,60 @@
11
# Leave a blank line at the end of this file to support concatenation
2+
airgap
3+
async
24
backend
35
backends
6+
backport
47
Charmcraft
58
cjk
69
cryptographically
10+
databag
711
dvipng
812
fonts
913
freefont
14+
Furo
1015
github
16+
GitHub
1117
GPG
1218
gyre
13-
https
1419
html
15-
io
20+
https
21+
InnoDB
1622
Intersphinx
23+
io
24+
ip
25+
Jira
26+
landscape
1727
lang
28+
lastmod
1829
LaTeX
1930
latexmk
31+
MinIO
2032
Multipass
33+
mydumper
34+
mysql
35+
MyST
36+
nameserver
37+
nameservers
38+
Open Graph
2139
otf
40+
PDF
41+
Percona
2242
plantuml
2343
PNG
44+
PR
2445
Pygments
2546
pymarkdown
2647
QEMU
27-
Rockcraft
48+
Read the Docs
2849
readthedocs
50+
reStructuredText
51+
Rockcraft
2952
rst
3053
sitemapindex
54+
snap_daemon
55+
Sphinx
56+
Spread
57+
spread_test_example
3158
subproject
3259
subprojects
3360
SVG
@@ -37,29 +64,17 @@ TOC
3764
toctree
3865
txt
3966
uncommenting
67+
URL
4068
utils
4169
VMs
4270
WCAG
4371
whitespace
4472
whitespaces
4573
wordlist
74+
xbstream
4675
xetex
4776
xindy
4877
xml
49-
ip
50-
spread_test_example
51-
Furo
52-
PDF
53-
Open Graph
54-
MyST
55-
YouTube
56-
reStructuredText
57-
GitHub
58-
Sphinx
59-
URL
60-
PR
61-
Read the Docs
62-
Spread
63-
landscape
64-
lastmod
78+
xtrabackup
6579
yaml
80+
YouTube

docs/.sphinx/update_sp.py

Lines changed: 0 additions & 269 deletions
This file was deleted.

0 commit comments

Comments
 (0)