WIP

ds-wizard · Aug 16, 2023 · d106bf4 · d106bf4
1 parent a8897f8
commit d106bf4
Show file tree

Hide file tree

Showing 6 changed files with 24 additions and 13 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -35,7 +35,7 @@ jobs:
 
     env:
       PUBLIC_IMAGE_PREFIX: 'datastewardshipwizard'
-      IMAGE_NAME: 'guide-changelog'
+      IMAGE_NAME: 'wizard-changelog'
       DOCKER_META_CONTEXT: '.'
       DOCKER_META_FILE: './Dockerfile'
       DOCKER_META_PLATFORMS: 'linux/amd64,linux/arm64'

diff --git a/Makefile b/Makefile
@@ -20,5 +20,5 @@ clean:
 
 .PHONY: docker
 docker:
-	docker build -t guide-changelog:local .
-	docker run --rm --name "guide-changelog" -p 8888:8080 guide-changelog:local
+	docker build -t wizard-changelog:local .
+	docker run --rm --name "wizard-changelog" -p 8888:8080 wizard-changelog:local
diff --git a/README.md b/README.md
@@ -1,15 +1,24 @@
-# Guide Changelog
+# Wizard Changelog
 
 [![User Guide](https://img.shields.io/badge/docs-User%20Guide-informational)](https://guide.ds-wizard.org)
 [![License](https://img.shields.io/github/license/ds-wizard/guide-changelog)](LICENSE)
 
-*Changelog for Data Stewardship Wizard Guide
+*Changelog for Data Stewardship Wizard*
 
 ### Requirements
 
  - **Python** (recommended 3.11)
  - **Makefile** (recommended 3.81)
 
+
+### Run
+
+For building the changelog, please run the following from the root of the project 
+
+```bash
+$ make build
+```
+
 ## License
 
 This project is licensed under the Apache License v2.0 - see the [LICENSE](LICENSE) file for more details.
diff --git a/assets/custom.js b/assets/custom.js
@@ -0,0 +1 @@
+console.log('Loaded Wizard changelog...')
diff --git a/changelog.rst b/changelog.rst
@@ -1,5 +1,5 @@
-Wizard Guide Changelog
-**********************
+Wizard Changelog
+****************
 
 ..
     This is a workaround to random anchor links generation by Sphinx

diff --git a/scripts/main.py b/scripts/main.py
@@ -28,24 +28,25 @@
                 f_out.write(
                     line
                     .replace(
-                        '<title>Wizard Guide Changelog</title>',
-                        """<title>Wizard Guide Changelog</title>
+                        '<title>Wizard Changelog</title>',
+                        """<title>Wizard Changelog</title>
                                   <link rel="shortcut icon" href="../assets/favicon.ico">
+                                  <script src="../assets/custom.js"></script>
                                """
                     )
                     .replace(
-                        '<h1 class="title">Wizard Guide Changelog</h1>',
+                        '<h1 class="title">Wizard Changelog</h1>',
                         ''
                     )
                     .replace(
-                        '<main id="wizard-guide-changelog">',
+                        '<main id="wizard-changelog">',
                         """<header>
                                     <h1>
                                         <img src="./assets/logo.svg" alt="Logo" class="logo">
-                                        <div class="title">| Guide Changelog</div>
+                                        <div class="title">| Wizard Changelog</div>
                                     </h1>
                                   </header>
-                                  <main id="wizard-guide-changelog">
+                                  <main id="wizard-changelog">
                         """
                     )
                 )