updates to product RTD site

.github/workflows/periodic-style-checks.yml

@@ -11,7 +11,7 @@ jobs:
     defaults:
       run:
         shell: bash
-        working-directory: "sp-docs"
+        working-directory: "docs"
     steps:
       - uses: actions/checkout@v4
       - name: Run vale

CHANGELOG.md

@@ -7,6 +7,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## 2024-12-17
+
+### Changes
+
+Updated the home page for the Read the Docs site to provide relevant information
+about the project.
+
+Updated the Periodic Style Checks to point to the correct directory.
+
 ## 2024-11-29
 
 ### Changes

docs/.custom_wordlist.txt

@@ -1,2 +1,3 @@
 Charmcraft
 Rockcraft
+OCI

docs/.sphinx/_templates/header.html

@@ -10,17 +10,13 @@
     <ul class="p-navigation__links" role="menu">
 
       <li>
-        <a class="p-logo" href="https://{{ product_page }}" aria-current="page">
+        <a class="p-logo" href="" aria-current="page">
           <img src="{{ pathto(product_tag,1) }}" alt="Logo" class="p-logo-image">
           <div class="p-logo-text p-heading--4">{{ project }}
           </div>
         </a>
       </li>
 
-      <li class="nav-ubuntu-com">
-        <a href="https://{{ product_page }}" class="p-navigation__link">{{ product_page }}</a>
-      </li>
-
       <li>
         <a href="#" class="p-navigation__link nav-more-links">More resources</a>
         <ul class="more-links-dropdown">
@@ -54,4 +50,4 @@
 
     </ul>
   </div>
-</header>
+</header>

docs/conf.py

@@ -26,7 +26,7 @@
 #
 # TODO: Update with the official name of your project or product
 
-project = "12-Factor app support in Charmcraft and Rockcraft"
+project = "12-Factor app support"
 author = "Canonical Ltd."
 
 
@@ -72,7 +72,7 @@
 # NOTE: The Open Graph Protocol (OGP) enhances page display in a social graph
 #       and is used by social media platforms; see https://ogp.me/
 
-ogp_site_url = "https://canonical-starter-pack.readthedocs-hosted.com/"
+ogp_site_url = ""
 
 
 # Preview name of the documentation website

docs/index.rst

@@ -4,16 +4,23 @@
 12-Factor app support in Charmcraft and Rockcraft
 =================================================
 
-**Coordinated pairs of Rockcraft and Charmcraft profiles designed to give you
-the content you need to generate rocks and charms for 12-Factor applications.**
+**A simple way to deploy and operate 12-Factor web applications.**
 
-**A paragraph of one to three short sentences, that describe what the product
-does.** 
+The ``paas-charm`` library provides frameworks in Rockcraft and
+Charmcraft to create the OCI image (rock) and packaged software
+(charm) necessary to quickly deploy your web application.
 
-**A third paragraph of similar length, this time explaining what need the
-product meets.**
+For developers and web application operators, this toolkit
+supports the ability to deploy, integrate, operate and manage
+your web application for production purposes. 
 
-**Finally, a paragraph that describes whom the product is useful for.** 
+The documentation is located in three places:
+
+1. This site: Documentation related to development
+2. `Rockcraft <https://documentation.ubuntu.com/rockcraft/en/latest/>`_:
+   Documentation related to the OCI image containers
+3. `Charmcraft <https://canonical-charmcraft.readthedocs-hosted.com/en/stable/>`_:
+   Documentation related to the packaged software (charms)
 
 ---------