update

.dockerignore

@@ -0,0 +1 @@
+.git*

.github/md_config.json

@@ -0,0 +1,17 @@
+{
+  "aliveStatusCodes": [429, 200, 520], 
+  "ignorePatterns": [
+    {
+      "pattern": "^(https://stakater).+"
+    },
+    {
+      "pattern": "^(http://nexus).+"
+    },
+    {
+      "pattern": "^(https://nexus).+"
+    },
+    {
+      "pattern": "^(https://docs.github.com).+"
+    }
+  ]
+}

.github/workflows/pull_request.yaml

@@ -0,0 +1,23 @@
+name: Pull Request
+
+on:
+  pull_request:
+    branches:
+      - 'main'
+
+jobs:
+  qa:
+    uses: stakater/.github/.github/workflows/[email protected]
+    with:
+      MD_CONFIG: .github/md_config.json
+      DOC_SRC: content
+      MD_LINT_CONFIG: .markdownlint.yaml
+  build:
+    uses: stakater/.github/.github/workflows/[email protected]
+    with:
+      DOCKER_FILE_PATH: Dockerfile
+    secrets:
+      CONTAINER_REGISTRY_URL: ${{ secrets.STAKATER_NEXUS_PREPROD_REGISTRY }}
+      CONTAINER_REGISTRY_USERNAME: ${{ secrets.STAKATER_NEXUS_PREPROD_USERNAME }}
+      CONTAINER_REGISTRY_PASSWORD: ${{ secrets.STAKATER_NEXUS_PREPROD_PASSWORD }}
+      SLACK_WEBHOOK_URL: ${{ secrets.STAKATER_DELIVERY_SLACK_WEBHOOK }}

.github/workflows/push.yaml

@@ -0,0 +1,19 @@
+name: Push
+
+on:
+  push:
+    branches:
+      - 'main'
+
+jobs:
+  push:
+    uses: stakater/.github/.github/workflows/[email protected]
+    with:
+      DOCKER_FILE_PATH: Dockerfile
+      RELEASE_BRANCH: main
+    secrets:
+      CONTAINER_REGISTRY_URL: ${{ secrets.STAKATER_NEXUS_PREPROD_REGISTRY }}/stakater
+      CONTAINER_REGISTRY_USERNAME: ${{ secrets.STAKATER_NEXUS_PREPROD_USERNAME }}
+      CONTAINER_REGISTRY_PASSWORD: ${{ secrets.STAKATER_NEXUS_PREPROD_PASSWORD }}
+      SLACK_WEBHOOK_URL: ${{ secrets.STAKATER_DELIVERY_SLACK_WEBHOOK }}
+      GH_TOKEN: ${{ secrets.STAKATER_GITHUB_TOKEN }}

.github/workflows/release.yaml

@@ -0,0 +1,12 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  release:
+    uses: stakater/.github/.github/workflows/[email protected]
+    secrets:
+      SLACK_WEBHOOK_URL: ${{ secrets.STAKATER_DELIVERY_SLACK_WEBHOOK }}

.gitignore

@@ -0,0 +1,22 @@
+# Dist files
+dist/
+lib/
+
+# Test temp files
+**/__fixtures__/.temp/
+
+# Test coverage files
+coverage/
+
+# MacOS Desktop Services Store
+.DS_Store
+
+# Log files
+*.log
+
+# Typescript build info
+*.tsbuildinfo
+node_modules
+
+# Build files
+site/

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "vocabulary"]
+	path = vocabulary
+	url = [email protected]:stakater/vocabulary.git

.markdownlint.yaml

@@ -0,0 +1,6 @@
+{
+  "MD007": { "indent": 4 },
+  "MD013": false,
+  "MD024": false,
+  "MD046": false,
+}

.vale.ini

@@ -0,0 +1,9 @@
+StylesPath = "vocabulary/styles"
+MinAlertLevel = warning
+
+Vocab = "Stakater"
+
+# Only check MarkDown files
+[*.md]
+
+BasedOnStyles = Vale

Dockerfile

@@ -0,0 +1,30 @@
+FROM python:3.11 as builder
+
+RUN pip3 install mkdocs-material mkdocs-mermaid2-plugin mkdocs-table-reader-plugin
+
+# set workdir
+RUN mkdir -p $HOME/application
+WORKDIR $HOME/application
+
+# copy the entire application
+COPY --chown=1001:root . .
+
+# build the docs
+RUN mkdocs build
+
+FROM nginxinc/nginx-unprivileged:1.24-alpine as deploy
+COPY --from=builder $HOME/application/site/ /usr/share/nginx/html/saap/
+COPY default.conf /etc/nginx/conf.d/
+
+# set non-root user
+USER 1001
+
+LABEL name="Stakater Support Documentation" \
+      maintainer="Stakater <[email protected]>" \
+      vendor="Stakater" \
+      release="1" \
+      summary="Documentation for Stakater Support"
+
+EXPOSE 8080:8080/tcp
+
+CMD ["nginx", "-g", "daemon off;"]

README.md

@@ -0,0 +1 @@
+# Stakater Support Documentation

content/index.md

@@ -0,0 +1,71 @@
+# Getting Support
+
+Stakater provides support to our customers via our [Service Desk Portal](https://stakater-cloud.atlassian.net/servicedesk/customer/portals).
+
+## Sign Up
+
+New users can sign up using their official email address by following this process:
+
+1. Go to the [Service Desk Portal](https://stakater-cloud.atlassian.net/servicedesk/customer/portals)
+
+2. Click on **Sign up**
+
+    ![image](./images/signup-support-1.png)
+
+3. Enter your official email address and click **Send link**
+
+    ![image](./images/signup-support-2.png)
+
+    You will be then redirected to following page
+
+    ![image](./images/signup-support-3.png)
+
+4. Check your email and click **Sign up**
+
+    ![image](./images/signup-support-4.png)
+
+5. Provide your full name, strong password and then click **Sign up**
+
+    ![image](./images/signup-support-5.png)
+
+## Request Support
+
+As a registered user you can go to the [Service Desk Portal](https://stakater-cloud.atlassian.net/servicedesk/customer/portals) to raise a support request.
+
+![image](./images/signup-support-6.png)
+
+## Priorities
+
+You as a customer can set the initial priority for a Request by specifying the appropriate priority: `Highest`, `High`, `Medium`, `Low`, or `Lowest`. The Engineer on Duty has the right to adjust it at their own discretion based on the rules below:
+
+Request Priority | Description of the Request Priority
+--- | ---
+`Highest` | Large-scale failure or complete unavailability of OpenShift or Customer's business application deployed on OpenShift. The `Highest` priority will be lowered to `High` if there is a workaround for the problem. Example: Router availability issues, synthetic monitoring availability issues.
+`High` | Partial degradation of OpenShift core functionality or Customer's business application functionality with potential adverse impact on long-term performance. The `High` priority will be lowered to `Medium` if there is a workaround for the problem. Example: Node Group and Control Plane availability problems.
+`Medium` | Partial, non-critical loss of functionality of OpenShift or the Customer's business application. This category also includes major bugs in OpenShift that affect some aspects of the Customer's operations and have no known solutions. The `Medium` priority will be lowered to `Low` if there is a workaround for the problem. This priority is assigned to Requests by default. If the Request does not have an priority set by the Customer, it will be assigned the default priority `Medium`. Example: Problems with the monitoring availability and Pod autoscaling.
+`Low` | This category includes: Requests for information and other matters, requests regarding extending the functionality of the Kubernetes Platform, performance issues that have no effect on functionality, Kubernetes platform flaws with known solutions or moderate impact on functionality. Example: Issues with extension availability.
+`Lowest` | Trivial problem with little or no impact on progress
+
+## Response Times
+
+Stakater strives to reach certain response and resolution times for each ticket. The response time is the maximum time it should take for Stakater Support to make an initial response to the ticket. The resolution time is the maximum time it should take for Stakater to assign the ticket a resolution.
+
+Request Priority | Time to first response | Time to resolution
+--- | --- | ---
+`Highest` | 2 h | 1 day
+`High` | 1 day | 2 days
+`Medium` | 3 days | 3 days
+`Low` | 4 days | 4 days
+`Lowest` | 5 days | 5 days
+
+## Resolution Time
+
+The time taken to resolve the problem does not include the time required to gain access to the Customer's environment or the data needed to verify and reproduce the problem. The calculation of time resumes as soon as the Customer provides the requested access to the environment or data. The Engineer on Duty has the right to downgrade the priority if the Customer fails to provide access to the environment or data within three hours of the Engineer's request.
+
+## Feedback
+
+Stakater adhere to openness in relations and directness in communications, so feedback is of great importance to us. Please, do not hesitate to share your comments and suggestions with us.
+
+Report any service-related discomfort as a support ticket. Company executives and owners would study it carefully. As a rule, Stakater recommend discussing and solving all problems directly with the Engineer on Duty first since they have the best knowledge of the task at hand and understands the context. However, in extreme situations, you can also contact company executives directly. Please note that in this case, additional time might be required for executives to study the problem and details, thus delaying the resolution of the issue. Still, if you feel there is a justified need to do so, do not hesitate to contact executives.
+
+Stakater commend you for choosing us, and Stakater sincerely hope for mutually beneficial, close, and long-standing cooperation!

custom_theme/404.html

@@ -0,0 +1,6 @@
+{% extends "main.html" %}
+
+{% block content %}
+  <h1>4xx - Page does not exist or has restricted access or rights</h1>
+  <p>This page does not exist or may have been deprecated or moved. Please use the search to find anything in the documentation.</p>
+{% endblock %}

custom_theme/main.html

@@ -0,0 +1,5 @@
+{% extends "base.html" %}
+
+{% block footer %}
+<p>Copyright &copy; 2023 Stakater AB – <a href="#__consent">Change cookie settings</a></p>
+{% endblock %}

default.conf

@@ -0,0 +1,9 @@
+server {
+    listen 8080;
+    root /usr/share/nginx/html/;
+    index index.html;
+    error_page 403 404 /404.html;
+    location = /404.html {
+        internal;
+    }
+}

mkdocs.yml

@@ -0,0 +1,53 @@
+site_name: Stakater Support
+docs_dir: content
+site_url: https://support.stakater.com/
+repo_url: https://github.com/stakater/support-docs
+edit_uri: blob/main/content/
+use_directory_urls: false
+theme:
+    name: material
+    logo: assets/images/favicon.svg
+    favicon: assets/images/favicon.svg
+    custom_dir: custom_theme/
+    palette:
+        primary: white
+
+markdown_extensions:
+  - admonition
+  - pymdownx.details
+  - pymdownx.superfences
+  - attr_list
+  - pymdownx.emoji:
+      emoji_index: !!python/name:materialx.emoji.twemoji
+      emoji_generator: !!python/name:materialx.emoji.to_svg
+
+extra:
+    analytics:
+        provider: google
+        property: G-TTH1YYW5TX
+    consent:
+        title: Cookie consent
+        actions:
+            - accept
+            - reject
+            - manage
+        description: >-
+            We use cookies to recognize your repeated visits and preferences, as well
+            as to measure the effectiveness of our documentation and whether users
+            find what they're searching for. With your consent, you're helping us to
+            make our documentation better.
+
+nav:
+    - Support:
+        - index.md
+    - Documentation: https://docs.stakater.com/
+    - Stakater Home: https://www.stakater.com/
+    - SAAP: https://www.stakater.com/saap-kubernetes-openshift
+    - Consultancy: https://www.stakater.com/kubernetes-consultancy
+    - Events: https://www.stakater.com/events
+    - Platform Assessment: https://www.stakater.com/kubernetes-platform-assessment
+    - Careers: https://www.stakater.com/careers
+
+plugins:
+    - search
+    - mermaid2