Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .copier-answers.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
_commit: 5875bae
_commit: d2d1381
_src_path: gh:canonical/platform-engineering-documentation-files.git
author: Canonical Ltd.
discourse: https://discourse.charmhub.io
Expand Down
5 changes: 5 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,11 @@
"""
)

# sphinx-markdown-builder (run by sphinx_llm.txt) has no visitor for these nodes.
# "meta" may be removable once liran-funaro/sphinx-markdown-builder#70 / NVIDIA/sphinx-llm#172 land;
# "mermaid" is unaddressed upstream and will still need suppressing.
llms_txt_suppress_unknown_node_warnings = ["meta", "mermaid"]

# The base URL for references built by sphinx-markdown-builder.
if os.environ.get("READTHEDOCS"):
markdown_http_base = html_baseurl
Expand Down
2 changes: 1 addition & 1 deletion docs/how-to/contribute.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ The purpose of these issues is to provide newcomers with opportunities to
contribute to our projects and gain documentation skills. Using AI to
complete these tasks undermines their purpose.

If you use AI to help with your PRs, be mindful. Avoid submitting contributions
If you use AI to help with your pull requests, be mindful. Avoid submitting contributions
with entirely AI-generated documentation. The human aspect of documentation is
important to us, and that includes tone, syntax, perspectives, and the
occasional typo.
Expand Down
16 changes: 6 additions & 10 deletions docs/release-notes/template/_release-artifact-template.yaml
Original file line number Diff line number Diff line change
@@ -1,17 +1,13 @@
# --- Information about release ----

version_schema: 2
version_schema: 3
workload_with_version::

# name of workload and version in the release
workload_with_version:
# Rows of the requirements table, for example "3.6", "MicroK8s 1.36", "24.04".
juju_version:
kubernetes_version:
ubuntu_version:

# list of change artifacts included in the release
included_changes:

# earliest revision included in the release
earliest_revision:

# latest revision included in the release
latest_revision:


4 changes: 2 additions & 2 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,11 @@ packaging==26.3
sphinxcontrib-svg2pdfconverter[CairoSVG]==2.1.0
sphinx-last-updated-by-git==0.3.8
sphinx-sitemap==2.9.0
sphinx-llm==1.0.0
sphinx-llm==1.1.0

# Mermaid diagrams
sphinxcontrib-mermaid==2.1.1

# Vale dependencies
rst2html==2020.7.4
vale==3.20.0.0
vale==3.22.0.0
Loading