docs/ISD-3479: Fixing vale errors

.custom_wordlist.txt

@@ -0,0 +1,6 @@
+config_changed
+upgrade_charm
+agent_relation_joined                 
+agent_relation_changed
+agent_relation_departed
+rebasing

.github/pull_request_template.md

@@ -8,15 +8,15 @@ Applicable spec: <link>
 
 <!-- The reason the change is needed -->
 
-### Juju Events Changes
+### Juju events changes
 
 <!-- Any changes to the juju events being observed (newly added, significantly modified or deleted) -->
 
-### Module Changes
+### Module changes
 
 <!-- Any high level changes to modules and why (Service, Observer, helper) -->
 
-### Library Changes
+### Library changes
 
 <!-- Any changes to charm libraries -->
 

README.md

@@ -1,4 +1,4 @@
-# Jenkins-agent-k8s Operator
+# Jenkins-agent-k8s operator
 
 [![CharmHub Badge](https://charmhub.io/jenkins-agent-k8s/badge.svg)](https://charmhub.io/jenkins-agent-k8s)
 [![Publish to edge](https://github.com/canonical/jenkins-agent-k8s-operator/actions/workflows/publish_charm.yaml/badge.svg)](https://github.com/canonical/jenkins-agent-k8s-operator/actions/workflows/publish_charm.yaml)

docs/explanation/charm-architecture.md

@@ -40,7 +40,7 @@ the agent application. The agent JAR is downloaded as `/var/lib/jenkins/agent.ja
 To indicate any startup failures, the `/var/lib/jenkins/agents.ready` file is created just before
 starting the agent application and removed if the agent was not able to start successfully.
 
-### Jenkins Agent Operator
+### Jenkins agent operator
 
 This container is the main point of contact with the Juju controller. It communicates with Juju to
 run necessary charm code defined by the main `src/charm.py`. The source code is copied to the
@@ -68,15 +68,15 @@ The [Jenkins](https://charmhub.io/jenkins-k8s) controller, a CI server for which
 For this charm, the following events are observed:
 
 1. [jenkins_agent_k8s_pebble_ready](https://juju.is/docs/sdk/container-name-pebble-ready-event): fired on Kubernetes charms when the requested container is ready.
-Action: wait for the integrations and configuration, download the JAR, configure the container and replan the service.
+Action: wait for the integrations and configuration, download the JAR, configure the container and re-plan the service.
 2. [config_changed](https://juju.is/docs/sdk/config-changed-event): usually fired in response to a configuration change using the CLI.
-Action: wait for the integrations and configuration, download the JAR, configure the container and replan the service.
+Action: wait for the integrations and configuration, download the JAR, configure the container and re-plan the service.
 3. [upgrade_charm](https://juju.is/docs/sdk/upgrade-charm-event): fired when a charm upgrade is triggered.
-Action: wait for the integrations and configuration, download the JAR, configure the container and replan the service.
+Action: wait for the integrations and configuration, download the JAR, configure the container and re-plan the service.
 4. [agent_relation_joined](https://juju.is/docs/sdk/relation-name-relation-joined-event): emitted when a unit joins the relation.
-Action: download the JAR, configure the container and replan the service.
-5. [agent_relation_changed](https://juju.is/docs/sdk/relation-name-relation-changed-event): triggered when another unit involved in the relation changed the data in the relation databag.
-Action: download the JAR, configure the container and replan the service.
+Action: download the JAR, configure the container and re-plan the service.
+5. [agent_relation_changed](https://juju.is/docs/sdk/relation-name-relation-changed-event): triggered when another unit involved in the relation changed the data in the relation data bag.
+Action: download the JAR, configure the container and re-plan the service.
 6. [agent_relation_departed](https://juju.is/docs/sdk/relation-name-relation-departed-event): fired when a unit departs the relation.
 Action: stop the service.
 

docs/how-to/contribute.md

@@ -16,7 +16,6 @@ This document explains the processes and practices recommended for contributing
   - test coverage
   - user experience for Juju operators of this charm.
 - Please help us out in ensuring easy to review branches by rebasing your pull request branch onto the `main` branch. This also avoids merge commits and creates a linear Git commit history.
-- Please generate src documentation for every commit. See the section below for more details.
 
 ## Developing
 
@@ -73,6 +72,6 @@ juju deploy ./jenkins-agent-k8s_ubuntu-22.04-amd64.charm \
   --resource jenkins-agent-k8s-image=localhost:32000/jenkins-agent-k8s:latest
 ```
 
-## Canonical Contributor Agreement
+## Canonical contributor agreement
 
 Canonical welcomes contributions to the Jenkins agent k8s operator. Please check out our [contributor agreement](https://ubuntu.com/legal/contributors) if you're interested in contributing to the solution.

docs/index.md

@@ -1,4 +1,4 @@
-# Jenkins Agent K8s Operator
+# Jenkins agent K8s operator
 
 A [Juju](https://juju.is/) [charm](https://juju.is/docs/olm/charmed-operators) deploying and managing [Jenkins](https://www.jenkins.io/) agents on Kubernetes. This charm is configurable to use with a Jenkins charm deployed in another Juju model, or to connect to a standalone Jenkins instance.
 

docs/reference/integrations.md

@@ -1,6 +1,8 @@
 # Integrations
-
+<!-- vale Canonical.007-Headings-sentence-case = off -->
+<!-- this is the name of the integration and stylized lowercase>
 ### agent
+<!-- vale Canonical.007-Headings-sentence-case = on -->
 
 _Interface_: jenkins_agent_v0  
 _Supported charms_: [jenkins](https://charmhub.io/jenkins)