Merge pull request #410 from stakater/fix-urls

fix urls

Author: TehreemNisa

.github/workflows/pull_request.yaml

@@ -39,22 +39,22 @@ jobs:
           username: ${{ github.actor }}
           password: ${{ secrets.GHCR_TOKEN }}
 
-      - name: Run Docker container for the saap-docs app
+      - name: Run Docker container for the kubestackplus-docs app
         run: |
-          docker run -d --name saap-docs -p 8080:8080 ${{ env.IMAGE_PATH }}
+          docker run -d --name kubestackplus-docs -p 8080:8080 ${{ env.IMAGE_PATH }}
 
-      - name: Wait for saap-docs app to be ready
+      - name: Wait for kubestackplus-docs app to be ready
         run: |
           timeout 60 bash -c 'until curl -f http://localhost:8080/ > /dev/null 2>&1; do sleep 2; done'
 
       - name: Run Playwright tests (Dockerized)
         run: |
           cd e2e
-          docker build -t saap-docs-e2e-tests .
-          docker run --rm --network host saap-docs-e2e-tests
+          docker build -t kubestackplus-docs-e2e-tests .
+          docker run --rm --network host kubestackplus-docs-e2e-tests
 
       - name: Cleanup Docker container
         if: always()
         run: |
-          docker stop saap-docs || true
-          docker rm saap-docs || true
+          docker stop kubestackplus-docs || true
+          docker rm kubestackplus-docs || true

Dockerfile

@@ -13,17 +13,17 @@ COPY --chown=1001:root . .
 RUN chmod +x prepare_theme.sh && ./prepare_theme.sh
 RUN mkdocs build
 FROM nginxinc/nginx-unprivileged:1.29-alpine AS deploy
-COPY --from=builder $HOME/application/site/ /usr/share/nginx/html/saap/
+COPY --from=builder $HOME/application/site/ /usr/share/nginx/html/kubestackplus/
 COPY default.conf /etc/nginx/conf.d/
 
 # set non-root user
 USER 1001
 
-LABEL name="Stakater App Agility Platform (SAAP) Documentation" \
+LABEL name="Stakater KubeStack+ Documentation" \
       maintainer="Stakater <hello@stakater.com>" \
       vendor="Stakater" \
       release="1" \
-      summary="Documentation for SAAP"
+      summary="Documentation for Stakater KubeStack+"
 
 EXPOSE 8080:8080/tcp
 

README.md

@@ -1,6 +1,6 @@
-# Stakater App Agility Platform (SAAP) Documentation
+# Stakater KubeStack+ Documentation
 
-SAAP docs are built using [MkDocs](https://github.com/mkdocs/mkdocs) which is based on Python.
+KubeStack+ docs are built using [MkDocs](https://github.com/mkdocs/mkdocs) which is based on Python.
 
 ## GitHub Actions
 
@@ -34,7 +34,7 @@ Run test container:
 docker run -p 8080:8080 test
 ```
 
-Then access the docs on [`localhost:8080/saap`](localhost:8080/saap).
+Then access the docs on [`localhost:8080/kubestackplus`](localhost:8080/kubestackplus).
 
 ### Run commands locally
 

default.conf

@@ -2,12 +2,12 @@ server {
     listen 8080;
     root /usr/share/nginx/html/;
     index index.html;
-    error_page 403 404 /saap/404.html;
-    location = /saap/404.html {
+    error_page 403 404 /kubestackplus/404.html;
+    location = /kubestackplus/404.html {
         internal;
     }
     location / {
-        try_files $uri $uri/ /saap/404.html;
+        try_files $uri $uri/ /kubestackplus/404.html;
     }
     # redirects issued by nginx will be relative
     absolute_redirect off;     

e2e/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "saap-docs-playwright-tests",
+  "name": "kubestackplus-docs-playwright-tests",
   "version": "1.0.0",
   "license": "MIT",
   "dependencies": {

e2e/src/run.spec.ts

@@ -23,17 +23,17 @@ async function openSearchIfVisible(page) {
 }
 
 test('Verify index file exists', async ({ page }) => {
-  await page.goto('/saap/index.html');
-  await expect(page).toHaveURL(/\/saap\/index\.html$/);
+  await page.goto('/kubestackplus/index.html');
+  await expect(page).toHaveURL(/\/kubestackplus\/index\.html$/);
 });
 
 test('Verify custom 404 file exists', async ({ page }) => {
-  await page.goto('/saap/404.html');
-  await expect(page).toHaveURL(/\/saap\/404\.html$/);
+  await page.goto('/kubestackplus/404.html');
+  await expect(page).toHaveURL(/\/kubestackplus\/404\.html$/);
 });
 
 test('Search for incorrectly rendered fenced code blocks', async ({ page }) => {
-  await page.goto('/saap/');
+  await page.goto('/kubestackplus/');
   await page.waitForLoadState('domcontentloaded');
   await acceptConsentIfPresent(page);
   await openSearchIfVisible(page);
@@ -48,7 +48,7 @@ test('Search for incorrectly rendered fenced code blocks', async ({ page }) => {
 });
 
 test('Search for incorrectly rendered admonitions', async ({ page }) => {
-  await page.goto('/saap/');
+  await page.goto('/kubestackplus/');
   await page.waitForLoadState('domcontentloaded');
   await acceptConsentIfPresent(page);
   await openSearchIfVisible(page);