Skip to content

Commit 7a2e679

Browse files
a-velascopaulomachizmalk
authored
Transfer documentation to Read The Docs. (#673)
* Integrate documentation starter pack into repository (#662) * add starter pack and raw markdown docs * add CI doc checks * clean up rogue files and add closing toctree backticks * fix H1 headings, end delimiters, and how-to/ references * fix sphinx build errors * update essential conf.py parameters * remove ci checks to avoid unnecessary runner use * fix typo * change main branch for rtd builds * remove sync_docs workflow and ignore docs folder in CI checks * fix toctrees and landing pages * fix spelling and link errors * add doc ci workflow * remove update script * Add mysql.com domains to linkcheck ignore * generalize azure portal url to ignore in linkcheck * remove emojis and discourse underline notation * refactor tutorial (wip) * update contacts page * polish tutorial * add manage-passwords guide * Fix spelling, broken links, and navigation issues (#666) * fix toctrees and landing pages * fix spelling and link errors * add doc ci workflow * 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]> * Fix old tutorial references and remove rogue PostgreSQL mentions * polish and sync with K8s * finish polishing and syncing with K8s * fix broken reference * update branch for readthedocs.yaml build check * fix broken links * fix broken link * docs: [DPE-7404] Promote-to-primary docs (#675) * promote-to-primary docs * rename and text fixes * typo fix * Update docs/index.md Co-authored-by: Vladimir Izmalkov <[email protected]> * Update docs/index.md Co-authored-by: Vladimir Izmalkov <[email protected]> * apply review comments --------- Co-authored-by: Paulo Machado <[email protected]> Co-authored-by: Vladimir Izmalkov <[email protected]>
1 parent d6efbab commit 7a2e679

File tree

113 files changed

+3539
-2184
lines changed

Some content is hidden

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

113 files changed

+3539
-2184
lines changed

‎.github/workflows/automatic-doc-checks.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
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+
concurrency:
15+
group: ${{ github.workflow }}-${{ github.ref }}
16+
cancel-in-progress: true
17+
18+
jobs:
19+
documentation-checks:
20+
uses: canonical/documentation-workflows/.github/workflows/documentation-checks.yaml@main
21+
with:
22+
working-directory: "docs"
23+
fetch-depth: 0

‎.github/workflows/check_libs.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ on:
1414
- 'LICENSE'
1515
- '**.md'
1616
- 'renovate.json'
17+
- 'docs/**'
1718

1819
jobs:
1920
lib-check:

‎.github/workflows/ci.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ on:
1111
paths-ignore:
1212
- '**.md'
1313
- '.github/renovate.json5'
14-
- '.github/workflows/sync_docs.yaml'
14+
- 'docs/**'
1515
schedule:
1616
- cron: '53 0 * * *' # Daily at 00:53 UTC
1717
# Triggered on push to branch "main" by .github/workflows/release.yaml

‎.github/workflows/release.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ on:
1010
- 'docs/**'
1111
- '.github/renovate.json5'
1212
- '.github/workflows/check_libs.yaml'
13-
- '.github/workflows/sync_docs.yaml'
1413

1514
jobs:
1615
ci-tests:

‎.github/workflows/sync_docs.yaml

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

‎.readthedocs.yaml

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# .readthedocs.yaml
2+
# Read the Docs configuration file
3+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4+
5+
# Required
6+
version: 2
7+
8+
# Set the version of Python and other tools you might need
9+
build:
10+
os: ubuntu-22.04
11+
tools:
12+
python: "3.11"
13+
jobs:
14+
post_checkout:
15+
- git fetch --unshallow || true
16+
# Cancel building pull requests when there aren't changed in the docs directory.
17+
# If there are no changes (git diff exits with 0) we force the command to return with 183.
18+
# This is a special exit code on Read the Docs that will cancel the build immediately.
19+
# https://docs.readthedocs.io/en/stable/build-customization.html#cancel-build-based-on-a-condition
20+
- |
21+
if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- 'docs/' '.readthedocs.yaml';
22+
then
23+
exit 183;
24+
fi
25+
26+
# Build documentation in the docs/ directory with Sphinx
27+
sphinx:
28+
builder: dirhtml
29+
configuration: docs/conf.py
30+
fail_on_warning: true
31+
32+
# If using Sphinx, optionally build your docs in additional formats such as PDF
33+
formats:
34+
- pdf
35+
36+
# Optionally declare the Python requirements required to build your docs
37+
python:
38+
install:
39+
- requirements: docs/requirements.txt

‎README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
[![CharmHub Badge](https://charmhub.io/mysql/badge.svg)](https://charmhub.io/mysql)
33
[![Release](https://github.com/canonical/mysql-operator/actions/workflows/release.yaml/badge.svg)](https://github.com/canonical/mysql-operator/actions/workflows/release.yaml)
44
[![Tests](https://github.com/canonical/mysql-operator/actions/workflows/ci.yaml/badge.svg?branch=main)](https://github.com/canonical/mysql-operator/actions/workflows/ci.yaml?query=branch%3Amain)
5-
[![Docs](https://github.com/canonical/mysql-operator/actions/workflows/sync_docs.yaml/badge.svg)](https://github.com/canonical/mysql-operator/actions/workflows/sync_docs.yaml)
65

76
## Description
87

‎docs/.custom_wordlist.txt

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
# Leave a blank line at the end of this file to support concatenation
2+
airgap
3+
async
4+
backend
5+
backends
6+
backport
7+
Charmcraft
8+
cjk
9+
cryptographically
10+
databag
11+
dvipng
12+
fonts
13+
freefont
14+
Furo
15+
github
16+
GitHub
17+
GPG
18+
gyre
19+
html
20+
https
21+
InnoDB
22+
Intersphinx
23+
io
24+
ip
25+
Jira
26+
landscape
27+
lang
28+
lastmod
29+
LaTeX
30+
latexmk
31+
MinIO
32+
Multipass
33+
mydumper
34+
mysql
35+
MyST
36+
nameserver
37+
nameservers
38+
Open Graph
39+
otf
40+
PDF
41+
Percona
42+
plantuml
43+
PNG
44+
PR
45+
Pygments
46+
pymarkdown
47+
QEMU
48+
Read the Docs
49+
readthedocs
50+
reStructuredText
51+
Rockcraft
52+
rst
53+
sitemapindex
54+
snap_daemon
55+
Sphinx
56+
Spread
57+
spread_test_example
58+
subproject
59+
subprojects
60+
SVG
61+
tex
62+
texlive
63+
TOC
64+
toctree
65+
txt
66+
uncommenting
67+
URL
68+
utils
69+
VMs
70+
WCAG
71+
whitespace
72+
whitespaces
73+
wordlist
74+
xbstream
75+
xetex
76+
xindy
77+
xml
78+
xtrabackup
79+
yaml
80+
YouTube

‎docs/.gitignore

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Environment
2+
*env*/
3+
.sphinx/venv/
4+
5+
# Sphinx
6+
.sphinx/warnings.txt
7+
.sphinx/.wordlist.dic
8+
.sphinx/.doctrees/
9+
.sphinx/update/
10+
.sphinx/node_modules/
11+
12+
# Vale
13+
.sphinx/styles/*
14+
.sphinx/vale.ini
15+
16+
# Build outputs
17+
_build
18+
19+
# Node.js
20+
package*.json
21+
22+
# Unrelated cache and config files
23+
.DS_Store
24+
__pycache__
25+
.idea/
26+
.vscode/

‎docs/.sphinx/.pre-commit-config.yaml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
repos:
2+
- repo: local
3+
hooks:
4+
- id: make-spelling
5+
name: Run make spelling
6+
entry: make -C docs spelling
7+
language: system
8+
pass_filenames: false
9+
files: ^docs/.*\.(rst|md|txt)$
10+
11+
- id: make-linkcheck
12+
name: Run make linkcheck
13+
entry: make -C docs linkcheck
14+
language: system
15+
pass_filenames: false
16+
files: ^docs/.*\.(rst|md|txt)$
17+
18+
- id: make-woke
19+
name: Run make woke
20+
entry: make -C docs woke
21+
language: system
22+
pass_filenames: false
23+
files: ^docs/.*\.(rst|md|txt)$

0 commit comments

Comments
 (0)