From dc74118794b414f77655580e49d92d495c0cc7a4 Mon Sep 17 00:00:00 2001 From: RSAK56 Date: Mon, 20 May 2024 17:19:33 +0500 Subject: [PATCH 1/5] Modified the run scrip, added logos for sap and updated yaml --- .gitmodules | 3 + README.md | 14 + custom_theme/404.html | 6 - custom_theme/main.html | 5 - mkdocs.yml | 712 +++++++++--------- prepare_theme.sh | 3 + theme_common | 1 + theme_override/mkdocs.yml | 348 +++++++++ .../resources}/assets/images/favicon.svg | 0 .../resources/assets/images/logo-dark.png | Bin 0 -> 2786 bytes .../resources/assets/images/logo-light.png | Bin 0 -> 1446 bytes 11 files changed, 736 insertions(+), 356 deletions(-) create mode 100644 .gitmodules delete mode 100644 custom_theme/404.html delete mode 100644 custom_theme/main.html create mode 100755 prepare_theme.sh create mode 160000 theme_common create mode 100644 theme_override/mkdocs.yml rename {custom_theme => theme_override/resources}/assets/images/favicon.svg (100%) create mode 100644 theme_override/resources/assets/images/logo-dark.png create mode 100644 theme_override/resources/assets/images/logo-light.png diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 00000000..93d493ff --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "theme_common"] + path = theme_common + url = git@github.com:stakater/stakater-docs-mkdocs-theme.git diff --git a/README.md b/README.md index 400b7b11..c1e689e6 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,12 @@ Install mkdocs-material and mermaid plugin: $ pip3 install mkdocs-material mkdocs-mermaid2-plugin ``` +Install mkdocs-include-markdown-plugin (if not installed by default and gives an error): + +```bash +$ pip install mkdocs-include-markdown-plugin +``` + Finally serve the docs using the built-in web server which is based on Python http server - note that the production build will use Nginx instead: ```bash @@ -77,3 +83,11 @@ Install [Tilt](https://docs.tilt.dev/index.html), then run: ```bash $ tilt up ``` + +Files `main.html` and `404.html` are served from `theme_common` rather than override since they are to be consistent throughout. If anything changes they can be served via `theme_override`. + +To execute the prepare theme command after setup you need to add the `prepare_theme.sh` or copy paste bash file using sudo cmd file to your root directory and then run the following cmd: + +```bash +$ chmod +x preparetheme sh +``` diff --git a/custom_theme/404.html b/custom_theme/404.html deleted file mode 100644 index bf6b1a3f..00000000 --- a/custom_theme/404.html +++ /dev/null @@ -1,6 +0,0 @@ -{% extends "main.html" %} - -{% block content %} -

4xx - Page does not exist or has restricted access or rights

-

This page does not exist or may have been deprecated or moved. Please use the search to find anything in the documentation.

-{% endblock %} diff --git a/custom_theme/main.html b/custom_theme/main.html deleted file mode 100644 index 56b53724..00000000 --- a/custom_theme/main.html +++ /dev/null @@ -1,5 +0,0 @@ -{% extends "base.html" %} - -{% block footer %} -

Copyright © 2023 Stakater AB – Change cookie settings

-{% endblock %} diff --git a/mkdocs.yml b/mkdocs.yml index 45e13bfd..0c6ad8f3 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,350 +1,372 @@ -site_name: Stakater App Agility Platform (SAAP) docs_dir: content -site_url: https://docs.stakater.com/saap/ -repo_url: https://github.com/stakater/saap-docs edit_uri: blob/main/content/ -use_directory_urls: false -strict: true -theme: - name: material - logo: assets/images/favicon.svg - favicon: assets/images/favicon.svg - custom_dir: custom_theme/ - features: - - content.code.copy - - content.code.select - palette: - primary: white - -markdown_extensions: - - admonition - - pymdownx.details - - pymdownx.superfences: - custom_fences: - - name: mermaid - class: mermaid - format: !!python/name:pymdownx.superfences.fence_code_format - - pymdownx.tabbed: - alternate_style: true - - attr_list - - tables - - pymdownx.emoji: - emoji_index: !!python/name:material.extensions.emoji.twemoji - emoji_generator: !!python/name:material.extensions.emoji.to_svg - - pymdownx.highlight: - anchor_linenums: true - line_spans: __span - pygments_lang_class: true - - pymdownx.inlinehilite - - pymdownx.snippets - extra: - analytics: - provider: google - property: G-TTH1YYW5TX - consent: - title: Cookie consent - actions: - - accept - - reject - - manage - description: >- - Stakater uses 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. - + analytics: + property: G-TTH1YYW5TX + provider: google + consent: + actions: + - accept + - reject + - manage + description: Stakater uses 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. + title: Cookie consent +extra_css: +- stylesheets/extra.css +markdown_extensions: +- admonition +- pymdownx.details +- pymdownx.superfences: + custom_fences: + - class: mermaid + format: !!python/name:pymdownx.superfences.fence_code_format '' + name: mermaid +- pymdownx.tabbed: + alternate_style: true +- attr_list +- tables +- pymdownx.emoji: + emoji_generator: !!python/name:material.extensions.emoji.to_svg '' + emoji_index: !!python/name:material.extensions.emoji.twemoji '' +- pymdownx.highlight: + anchor_linenums: true + line_spans: __span + pygments_lang_class: true +- pymdownx.inlinehilite +- pymdownx.snippets nav: - - About: - - index.md - - Enterprise Kubernetes: about/saap-vs-k8s.md - - about/saap-features.md - - about/saap-key-differentiators.md - - Service Definition: - - about/service-definition/overview.md - - about/service-definition/platform.md - - about/service-definition/monitoring.md - - about/service-definition/logging.md - - about/service-definition/security.md - - about/service-definition/secrets-management.md - - about/service-definition/service-mesh.md - - about/service-definition/account-management.md - - about/service-definition/networking.md - - about/service-definition/storage.md - - about/responsibilities.md - - Cloud Providers: - - about/cloud-providers/overview.md - - about/cloud-providers/aws.md - - about/cloud-providers/azure.md - - about/cloud-providers/gcp.md - - about/cloud-providers/binero.md - - about/cloud-providers/exoscale.md - - about/update-lifecycle.md - - about/onboarding.md - - For Administrators: - - for-administrators/overview.md - - Plan your environment: - - for-administrators/plan-your-environment/sizing.md - - Secure your cluster: - - for-administrators/secure-your-cluster/user-access.md - - for-administrators/secure-your-cluster/secure-routes.md - - for-administrators/secure-your-cluster/google-idp.md - - for-administrators/secure-your-cluster/azure-idp.md - - for-administrators/secure-your-cluster/keycloak-idp.md - - for-administrators/secure-your-cluster/saml-idp.md - - for-administrators/secure-your-cluster/saap-authorization-roles.md - - for-administrators/secure-your-cluster/curated-list-operators.md - - Manage Network: - - for-administrators/networking/custom-domains.md - - for-administrators/networking/external-dns.md - - Manage Storage: - - for-administrators/storage/volume-expansion.md - - Cluster Lifecycle: - - for-administrators/cluster-lifecycle/hibernate-your-cluster.md - - Help: - - for-administrators/help/faq.md - - Explanation: - - for-administrators/explanation/number-of-clusters.md - - For Delivery Engineers: - - for-delivery-engineers/overview.md - - Explanation: - - for-delivery-engineers/explanation/gitops-intro.md - - for-delivery-engineers/explanation/gitops-structure.md - - for-delivery-engineers/explanation/secrets.md - - for-delivery-engineers/explanation/types-of-environments.md - - for-delivery-engineers/explanation/stakater-tekton-chart.md - - for-delivery-engineers/explanation/faq.md - - Tutorials: - - for-delivery-engineers/tutorials/04-preparing-pac-env/adding-github-token.md - - for-delivery-engineers/tutorials/01-configure-infra-gitops-config/configure-infra-gitops-repo.md - - for-delivery-engineers/tutorials/02-configure-apps-gitops-config/configure-apps-gitops-repo.md - - for-delivery-engineers/tutorials/04-preparing-pac-env/add-ssh-key.md - - for-delivery-engineers/tutorials/03-deploy-demo-app/deploy-demo-app.md - - How-to guides: - - for-delivery-engineers/how-to-guides/configure-repository-secret/configure-repository-secret.md - - for-delivery-engineers/how-to-guides/add-a-cluster-task/add-cluster-task.md - - for-delivery-engineers/how-to-guides/use-a-cluster-task-in-pipeline/use-a-clustertask-in-pipeline.md - - For Developers: - - for-developers/overview.md - - Explanation: - - for-developers/explanation/developer-training.md - - for-developers/explanation/plan-your-deployment.md - - for-developers/explanation/inner-outer-loop.md - - for-developers/explanation/local-development-workflow.md - - for-developers/explanation/production-best-practices.md - - for-developers/explanation/deploying-secrets.md - - - Tutorials: - - Inner Loop: - - for-developers/tutorials/inner-loop/prepare-environment/prepare-env.md - - for-developers/tutorials/inner-loop/about-application/about-application.md - - for-developers/tutorials/inner-loop/access-the-cluster/access-the-cluster.md - - for-developers/tutorials/inner-loop/containerize-app/containerize-app.md - - for-developers/tutorials/inner-loop/package-app/package-app.md - - for-developers/tutorials/inner-loop/deploy-app/deploy-app.md - - for-developers/tutorials/inner-loop/add-secret/add-secrets.md - - for-developers/tutorials/inner-loop/add-configmap/add-configmaps.md - - for-developers/tutorials/inner-loop/configure-probes/configure-probes.md - - for-developers/tutorials/inner-loop/add-storage/persist-app.md - - for-developers/tutorials/inner-loop/expose-app/expose-app.md - - for-developers/tutorials/inner-loop/validate-logs/validate-logs.md - - for-developers/tutorials/inner-loop/monitor-your-app/monitor-your-app.md - - for-developers/tutorials/inner-loop/expose-metrics/expose-metrics.md - - for-developers/tutorials/inner-loop/add-alerts/add-alerts.md - - for-developers/tutorials/inner-loop/synthetic-monitoring/synthetic-monitoring.md - - for-developers/tutorials/inner-loop/add-grafana-dashboard/add-grafana-dashboard.md - - for-developers/tutorials/inner-loop/scale-app/scale-app.md - - for-developers/tutorials/inner-loop/validate-auto-reload/validate-auto-reload.md - - for-developers/tutorials/inner-loop/add-pdb/add-pdb.md - - for-developers/tutorials/inner-loop/add-network-policy/add-network-policy.md - - for-developers/tutorials/inner-loop/tilt-zero-to-hero/step-by-step-guide.md - - Outer Loop: - - for-developers/tutorials/outer-loop/access-cluster/access-the-cluster.md - - for-developers/tutorials/outer-loop/prerequisites.md - - for-developers/tutorials/outer-loop/add-build-environment/add-environment.md - - Configure Pipeline for your application: - - for-developers/tutorials/outer-loop/add-ci-pipeline/01-overview.md - - for-developers/tutorials/outer-loop/add-ci-pipeline/03-create-webhook.md - - for-developers/tutorials/outer-loop/add-ci-pipeline/05-create-repository.md - - Add PipelineRun: - - for-developers/tutorials/outer-loop/add-ci-pipeline/06-adding-pipeline.md - - for-developers/tutorials/outer-loop/add-ci-pipeline/07-add-create-git-tag.md - - for-developers/tutorials/outer-loop/add-ci-pipeline/08-add-create-environment.md - - for-developers/tutorials/outer-loop/add-ci-pipeline/09-add-code-linting.md - - for-developers/tutorials/outer-loop/add-ci-pipeline/10-add-kube-linting.md - - for-developers/tutorials/outer-loop/add-ci-pipeline/11-add-unit-test.md - - for-developers/tutorials/outer-loop/add-ci-pipeline/12-add-sonar-scan.md - - for-developers/tutorials/outer-loop/add-ci-pipeline/13-add-buildah.md - - for-developers/tutorials/outer-loop/add-ci-pipeline/14-add-trivy-scan.md - - for-developers/tutorials/outer-loop/add-ci-pipeline/15-add-rox-image-scan.md - - for-developers/tutorials/outer-loop/add-ci-pipeline/16-add-rox-image-check.md - - for-developers/tutorials/outer-loop/add-ci-pipeline/17-add-rox-deployment-check.md - - for-developers/tutorials/outer-loop/add-ci-pipeline/18-add-checkov-scan.md - - for-developers/tutorials/outer-loop/add-ci-pipeline/19-add-helm-push.md - - for-developers/tutorials/outer-loop/add-ci-pipeline/20-add-update-cd-repo.md - - for-developers/tutorials/outer-loop/add-ci-pipeline/21-add-validate-environment.md - - for-developers/tutorials/outer-loop/promote-application/promote-app.md - - How-to guides: - - for-developers/how-to-guides/add-a-new-environment-to-apps-gitops/add-a-new-environment-to-application.md - - for-developers/how-to-guides/promote-your-application/promote-your-application.md - - for-developers/how-to-guides/build-and-push-your-image/build-and-push-your-image.md - - for-developers/how-to-guides/deploy-app-with-argocd-and-helm/deploy-app-with-argocd-and-helm.md - - for-developers/how-to-guides/expose-spring-boot-metrics/expose-spring-boot-metrics.md - - for-developers/how-to-guides/package-and-push-your-chart/package-and-push-your-chart.md - - For CISOs: - - for-cisos/policies/policies.md - - Red Hat Advanced Cluster Security (RHACS): - - for-cisos/rhacs/introduction.md - - for-cisos/rhacs/accessing-rhacs.md - - for-cisos/rhacs/permissions.md - - Backup and Restore: - - for-cisos/backup-restore/introduction.md - - for-cisos/backup-restore/velero-cli.md - - for-cisos/backup-restore/backup-restore.md - - for-cisos/backup-restore/troubleshooting.md - - for-cisos/backup-restore/cleanup.md - - for-cisos/backup-restore/stateful-app-example.md - - for-cisos/backup-restore/restore-with-gitops.md - - for-cisos/backup-restore/limitations.md - - Data Protection: - - for-cisos/data-protection/gdpr.md - - for-cisos/data-protection/rhacm-data-lifecycle.md - - for-cisos/data-protection/rhacm-data-collection.md - - for-cisos/data-protection/rhacm-data-storage.md - - Managed Addons: - - managed-addons/overview.md - - Nexus: - - managed-addons/nexus/overview.md - - Tutorials: - - managed-addons/nexus/tutorial/login-browse.md - - How-to guides: - - managed-addons/nexus/how-to-guide/how-to-configure-maven-with-nexus.md - - managed-addons/nexus/how-to-guide/how-to-upload-from-ui.md - - managed-addons/nexus/how-to-guide/how-to-upload-local-machine.md - - managed-addons/nexus/how-to-guide/how-to-grant-admin-privileges.md - - Explanation: - - managed-addons/nexus/explanation/routes.md - - managed-addons/nexus/explanation/permissions.md - - Vault: - - managed-addons/vault/overview.md - - ArgoCD: - - managed-addons/argocd/overview.md - - managed-addons/argocd/for-administrators/availability.md - - managed-addons/argocd/for-administrators/installation.md - - managed-addons/argocd/for-administrators/observability.md - - managed-addons/argocd/for-administrators/resource-requirements.md - - Cert Manager: - - managed-addons/cert-manager/overview.md - - External Secrets Operator: - - managed-addons/external-secrets-operator/overview.md - - Forecastle: - - managed-addons/forecastle/overview.md - - Tutorials: - - managed-addons/forecastle/tutorial/add-forecastle-app.md - - Tilt: - - managed-addons/tilt/overview.md - - Renovate: - - managed-addons/renovate/overview.md - - How-to guides: - - managed-addons/renovate/how-to-guides/automerge.md - - managed-addons/renovate/how-to-guides/run-locally.md - - Gatekeeper: - - managed-addons/gatekeeper/overview.md - - Showback: - - managed-addons/opencost/overview.md - - Restful Distributed Lock Manager (RDLM): - - managed-addons/rdlm/overview.md - - Ingress Monitor Controller: - - managed-addons/imc/overview.md - - Tutorials: - - managed-addons/imc/tutorial/add-configuration.md - - managed-addons/imc/tutorial/add-monitors.md - - Konfigurator: - - managed-addons/konfigurator/overview.md - - Explanation: - - managed-addons/konfigurator/explanation/konfigurator-template.md - - managed-addons/konfigurator/explanation/pod-metadata-injector.md - - Logging: - - managed-addons/logging-stack/overview.md - - managed-addons/logging-stack/kibana-view-logs.md - - Monitoring: - - managed-addons/monitoring-stack/overview.md - - managed-addons/monitoring-stack/stack.md - - managed-addons/monitoring-stack/app-uptime.md - - managed-addons/monitoring-stack/app-alerts.md - - managed-addons/monitoring-stack/grafana-dashboard.md - - managed-addons/monitoring-stack/downtime-notifications-uptimerobot.md - - managed-addons/monitoring-stack/log-alerts.md - - managed-addons/monitoring-stack/predefined-prometheusrules.md - - managed-addons/monitoring-stack/workload-application-alerts.md - - Multi Tenant Operator: - - managed-addons/mto/overview.md - - Reloader: - - managed-addons/reloader/overview.md - - Tutorials: - - managed-addons/reloader/tutorial/configure-resources.md - - SonarQube: - - managed-addons/sonarqube/overview.md - - Tekton: - - managed-addons/tekton/overview.md - - Tronador: - - managed-addons/tronador/overview.md - - Velero: - - managed-addons/velero/overview.md - - Volume Expander Operator: - - managed-addons/volume-expander-operator/overview.md - - RHACS: - - managed-addons/rhacs/overview.md - - Vertical Pod Autoscaler (VPA): - - managed-addons/vertical-pod-autoscaler/overview.md - - Horizontal Pod Autoscaler (HPA): - - managed-addons/horizontal-pod-autoscaler/overview.md - - Pelorus: - - managed-addons/pelorus/overview.md - - Service Mesh: - - managed-addons/service-mesh/overview.md - - Patch Operator: - - managed-addons/patch-operator/overview.md - - Ingress Controller: - - managed-addons/ingress-controller/overview.md - - Event Router: - - managed-addons/event-router/overview.md - - Kubernetes Dashboard: - - managed-addons/kubernetes-dashboard/overview.md - - OpenShift Data Foundation: - - managed-addons/odf/overview.md - - Custom Metrics Autoscaler: - - managed-addons/custom-metrics-autoscaler/overview.md - - Dev Spaces: - - managed-addons/devspaces/overview.md - - External DNS: - - managed-addons/external-dns/overview.md - - Helm Leader Chart: - - managed-addons/helm-leader-chart/overview.md - - Web Terminal Operator: - - managed-addons/web-terminal-operator/overview.md - - Legal Documents: - - legal-documents/gtc.md - - legal-documents/sla.md - - legal-documents/agreement.md - - legal-documents/dpa.md - - legal-documents/nda.md - - legal-documents/pp.md - - Help: - - help/support/support.md - - Kubernetes Concepts: - - help/k8s-concepts/storage-basics.md - - help/k8s-concepts/cloud-native-app.md - - help/k8s-concepts/helm.md - - help/k8s-concepts/high-availability.md - - FAQs: - - help/faqs/product.md - - help/faqs/purchasing.md - - help/faqs/customization.md - - help/faqs/developers.md - - help/faqs/operations.md - +- About: + - index.md + - Enterprise Kubernetes: about/saap-vs-k8s.md + - about/saap-features.md + - about/saap-key-differentiators.md + - Service Definition: + - about/service-definition/overview.md + - about/service-definition/platform.md + - about/service-definition/monitoring.md + - about/service-definition/logging.md + - about/service-definition/security.md + - about/service-definition/secrets-management.md + - about/service-definition/service-mesh.md + - about/service-definition/account-management.md + - about/service-definition/networking.md + - about/service-definition/storage.md + - about/responsibilities.md + - Cloud Providers: + - about/cloud-providers/overview.md + - about/cloud-providers/aws.md + - about/cloud-providers/azure.md + - about/cloud-providers/gcp.md + - about/cloud-providers/binero.md + - about/cloud-providers/exoscale.md + - about/update-lifecycle.md + - about/onboarding.md +- For Administrators: + - for-administrators/overview.md + - Plan your environment: + - for-administrators/plan-your-environment/sizing.md + - Secure your cluster: + - for-administrators/secure-your-cluster/user-access.md + - for-administrators/secure-your-cluster/secure-routes.md + - for-administrators/secure-your-cluster/google-idp.md + - for-administrators/secure-your-cluster/azure-idp.md + - for-administrators/secure-your-cluster/keycloak-idp.md + - for-administrators/secure-your-cluster/saml-idp.md + - for-administrators/secure-your-cluster/saap-authorization-roles.md + - for-administrators/secure-your-cluster/curated-list-operators.md + - Manage Network: + - for-administrators/networking/custom-domains.md + - for-administrators/networking/external-dns.md + - Manage Storage: + - for-administrators/storage/volume-expansion.md + - Cluster Lifecycle: + - for-administrators/cluster-lifecycle/hibernate-your-cluster.md + - Help: + - for-administrators/help/faq.md + - Explanation: + - for-administrators/explanation/number-of-clusters.md +- For Delivery Engineers: + - for-delivery-engineers/overview.md + - Explanation: + - for-delivery-engineers/explanation/gitops-intro.md + - for-delivery-engineers/explanation/gitops-structure.md + - for-delivery-engineers/explanation/secrets.md + - for-delivery-engineers/explanation/types-of-environments.md + - for-delivery-engineers/explanation/stakater-tekton-chart.md + - for-delivery-engineers/explanation/faq.md + - Tutorials: + - for-delivery-engineers/tutorials/04-preparing-pac-env/adding-github-token.md + - for-delivery-engineers/tutorials/01-configure-infra-gitops-config/configure-infra-gitops-repo.md + - for-delivery-engineers/tutorials/02-configure-apps-gitops-config/configure-apps-gitops-repo.md + - for-delivery-engineers/tutorials/04-preparing-pac-env/add-ssh-key.md + - for-delivery-engineers/tutorials/03-deploy-demo-app/deploy-demo-app.md + - How-to guides: + - for-delivery-engineers/how-to-guides/configure-repository-secret/configure-repository-secret.md + - for-delivery-engineers/how-to-guides/add-a-cluster-task/add-cluster-task.md + - for-delivery-engineers/how-to-guides/use-a-cluster-task-in-pipeline/use-a-clustertask-in-pipeline.md +- For Developers: + - for-developers/overview.md + - Explanation: + - for-developers/explanation/developer-training.md + - for-developers/explanation/plan-your-deployment.md + - for-developers/explanation/inner-outer-loop.md + - for-developers/explanation/local-development-workflow.md + - for-developers/explanation/production-best-practices.md + - for-developers/explanation/deploying-secrets.md + - Tutorials: + - Inner Loop: + - for-developers/tutorials/inner-loop/prepare-environment/prepare-env.md + - for-developers/tutorials/inner-loop/about-application/about-application.md + - for-developers/tutorials/inner-loop/access-the-cluster/access-the-cluster.md + - for-developers/tutorials/inner-loop/containerize-app/containerize-app.md + - for-developers/tutorials/inner-loop/package-app/package-app.md + - for-developers/tutorials/inner-loop/deploy-app/deploy-app.md + - for-developers/tutorials/inner-loop/add-secret/add-secrets.md + - for-developers/tutorials/inner-loop/add-configmap/add-configmaps.md + - for-developers/tutorials/inner-loop/configure-probes/configure-probes.md + - for-developers/tutorials/inner-loop/add-storage/persist-app.md + - for-developers/tutorials/inner-loop/expose-app/expose-app.md + - for-developers/tutorials/inner-loop/validate-logs/validate-logs.md + - for-developers/tutorials/inner-loop/monitor-your-app/monitor-your-app.md + - for-developers/tutorials/inner-loop/expose-metrics/expose-metrics.md + - for-developers/tutorials/inner-loop/add-alerts/add-alerts.md + - for-developers/tutorials/inner-loop/synthetic-monitoring/synthetic-monitoring.md + - for-developers/tutorials/inner-loop/add-grafana-dashboard/add-grafana-dashboard.md + - for-developers/tutorials/inner-loop/scale-app/scale-app.md + - for-developers/tutorials/inner-loop/validate-auto-reload/validate-auto-reload.md + - for-developers/tutorials/inner-loop/add-pdb/add-pdb.md + - for-developers/tutorials/inner-loop/add-network-policy/add-network-policy.md + - for-developers/tutorials/inner-loop/tilt-zero-to-hero/step-by-step-guide.md + - Outer Loop: + - for-developers/tutorials/outer-loop/access-cluster/access-the-cluster.md + - for-developers/tutorials/outer-loop/prerequisites.md + - for-developers/tutorials/outer-loop/add-build-environment/add-environment.md + - Configure Pipeline for your application: + - for-developers/tutorials/outer-loop/add-ci-pipeline/01-overview.md + - for-developers/tutorials/outer-loop/add-ci-pipeline/03-create-webhook.md + - for-developers/tutorials/outer-loop/add-ci-pipeline/05-create-repository.md + - Add PipelineRun: + - for-developers/tutorials/outer-loop/add-ci-pipeline/06-adding-pipeline.md + - for-developers/tutorials/outer-loop/add-ci-pipeline/07-add-create-git-tag.md + - for-developers/tutorials/outer-loop/add-ci-pipeline/08-add-create-environment.md + - for-developers/tutorials/outer-loop/add-ci-pipeline/09-add-code-linting.md + - for-developers/tutorials/outer-loop/add-ci-pipeline/10-add-kube-linting.md + - for-developers/tutorials/outer-loop/add-ci-pipeline/11-add-unit-test.md + - for-developers/tutorials/outer-loop/add-ci-pipeline/12-add-sonar-scan.md + - for-developers/tutorials/outer-loop/add-ci-pipeline/13-add-buildah.md + - for-developers/tutorials/outer-loop/add-ci-pipeline/14-add-trivy-scan.md + - for-developers/tutorials/outer-loop/add-ci-pipeline/15-add-rox-image-scan.md + - for-developers/tutorials/outer-loop/add-ci-pipeline/16-add-rox-image-check.md + - for-developers/tutorials/outer-loop/add-ci-pipeline/17-add-rox-deployment-check.md + - for-developers/tutorials/outer-loop/add-ci-pipeline/18-add-checkov-scan.md + - for-developers/tutorials/outer-loop/add-ci-pipeline/19-add-helm-push.md + - for-developers/tutorials/outer-loop/add-ci-pipeline/20-add-update-cd-repo.md + - for-developers/tutorials/outer-loop/add-ci-pipeline/21-add-validate-environment.md + - for-developers/tutorials/outer-loop/promote-application/promote-app.md + - How-to guides: + - for-developers/how-to-guides/add-a-new-environment-to-apps-gitops/add-a-new-environment-to-application.md + - for-developers/how-to-guides/promote-your-application/promote-your-application.md + - for-developers/how-to-guides/build-and-push-your-image/build-and-push-your-image.md + - for-developers/how-to-guides/deploy-app-with-argocd-and-helm/deploy-app-with-argocd-and-helm.md + - for-developers/how-to-guides/expose-spring-boot-metrics/expose-spring-boot-metrics.md + - for-developers/how-to-guides/package-and-push-your-chart/package-and-push-your-chart.md +- For CISOs: + - for-cisos/policies/policies.md + - Red Hat Advanced Cluster Security (RHACS): + - for-cisos/rhacs/introduction.md + - for-cisos/rhacs/accessing-rhacs.md + - for-cisos/rhacs/permissions.md + - Backup and Restore: + - for-cisos/backup-restore/introduction.md + - for-cisos/backup-restore/velero-cli.md + - for-cisos/backup-restore/backup-restore.md + - for-cisos/backup-restore/troubleshooting.md + - for-cisos/backup-restore/cleanup.md + - for-cisos/backup-restore/stateful-app-example.md + - for-cisos/backup-restore/restore-with-gitops.md + - for-cisos/backup-restore/limitations.md + - Data Protection: + - for-cisos/data-protection/gdpr.md + - for-cisos/data-protection/rhacm-data-lifecycle.md + - for-cisos/data-protection/rhacm-data-collection.md + - for-cisos/data-protection/rhacm-data-storage.md +- Managed Addons: + - managed-addons/overview.md + - Nexus: + - managed-addons/nexus/overview.md + - Tutorials: + - managed-addons/nexus/tutorial/login-browse.md + - How-to guides: + - managed-addons/nexus/how-to-guide/how-to-configure-maven-with-nexus.md + - managed-addons/nexus/how-to-guide/how-to-upload-from-ui.md + - managed-addons/nexus/how-to-guide/how-to-upload-local-machine.md + - managed-addons/nexus/how-to-guide/how-to-grant-admin-privileges.md + - Explanation: + - managed-addons/nexus/explanation/routes.md + - managed-addons/nexus/explanation/permissions.md + - Vault: + - managed-addons/vault/overview.md + - ArgoCD: + - managed-addons/argocd/overview.md + - managed-addons/argocd/for-administrators/availability.md + - managed-addons/argocd/for-administrators/installation.md + - managed-addons/argocd/for-administrators/observability.md + - managed-addons/argocd/for-administrators/resource-requirements.md + - Cert Manager: + - managed-addons/cert-manager/overview.md + - External Secrets Operator: + - managed-addons/external-secrets-operator/overview.md + - Forecastle: + - managed-addons/forecastle/overview.md + - Tutorials: + - managed-addons/forecastle/tutorial/add-forecastle-app.md + - Tilt: + - managed-addons/tilt/overview.md + - Renovate: + - managed-addons/renovate/overview.md + - How-to guides: + - managed-addons/renovate/how-to-guides/automerge.md + - managed-addons/renovate/how-to-guides/run-locally.md + - Gatekeeper: + - managed-addons/gatekeeper/overview.md + - Showback: + - managed-addons/opencost/overview.md + - Restful Distributed Lock Manager (RDLM): + - managed-addons/rdlm/overview.md + - Ingress Monitor Controller: + - managed-addons/imc/overview.md + - Tutorials: + - managed-addons/imc/tutorial/add-configuration.md + - managed-addons/imc/tutorial/add-monitors.md + - Konfigurator: + - managed-addons/konfigurator/overview.md + - Explanation: + - managed-addons/konfigurator/explanation/konfigurator-template.md + - managed-addons/konfigurator/explanation/pod-metadata-injector.md + - Logging: + - managed-addons/logging-stack/overview.md + - managed-addons/logging-stack/kibana-view-logs.md + - Monitoring: + - managed-addons/monitoring-stack/overview.md + - managed-addons/monitoring-stack/stack.md + - managed-addons/monitoring-stack/app-uptime.md + - managed-addons/monitoring-stack/app-alerts.md + - managed-addons/monitoring-stack/grafana-dashboard.md + - managed-addons/monitoring-stack/downtime-notifications-uptimerobot.md + - managed-addons/monitoring-stack/log-alerts.md + - managed-addons/monitoring-stack/predefined-prometheusrules.md + - managed-addons/monitoring-stack/workload-application-alerts.md + - Multi Tenant Operator: + - managed-addons/mto/overview.md + - Reloader: + - managed-addons/reloader/overview.md + - Tutorials: + - managed-addons/reloader/tutorial/configure-resources.md + - SonarQube: + - managed-addons/sonarqube/overview.md + - Tekton: + - managed-addons/tekton/overview.md + - Tronador: + - managed-addons/tronador/overview.md + - Velero: + - managed-addons/velero/overview.md + - Volume Expander Operator: + - managed-addons/volume-expander-operator/overview.md + - RHACS: + - managed-addons/rhacs/overview.md + - Vertical Pod Autoscaler (VPA): + - managed-addons/vertical-pod-autoscaler/overview.md + - Horizontal Pod Autoscaler (HPA): + - managed-addons/horizontal-pod-autoscaler/overview.md + - Pelorus: + - managed-addons/pelorus/overview.md + - Service Mesh: + - managed-addons/service-mesh/overview.md + - Patch Operator: + - managed-addons/patch-operator/overview.md + - Ingress Controller: + - managed-addons/ingress-controller/overview.md + - Event Router: + - managed-addons/event-router/overview.md + - Kubernetes Dashboard: + - managed-addons/kubernetes-dashboard/overview.md + - OpenShift Data Foundation: + - managed-addons/odf/overview.md + - Custom Metrics Autoscaler: + - managed-addons/custom-metrics-autoscaler/overview.md + - Dev Spaces: + - managed-addons/devspaces/overview.md + - External DNS: + - managed-addons/external-dns/overview.md + - Helm Leader Chart: + - managed-addons/helm-leader-chart/overview.md + - Web Terminal Operator: + - managed-addons/web-terminal-operator/overview.md +- Legal Documents: + - legal-documents/gtc.md + - legal-documents/sla.md + - legal-documents/agreement.md + - legal-documents/dpa.md + - legal-documents/nda.md + - legal-documents/pp.md +- Help: + - help/support/support.md + - Kubernetes Concepts: + - help/k8s-concepts/storage-basics.md + - help/k8s-concepts/cloud-native-app.md + - help/k8s-concepts/helm.md + - help/k8s-concepts/high-availability.md + - FAQs: + - help/faqs/product.md + - help/faqs/purchasing.md + - help/faqs/customization.md + - help/faqs/developers.md + - help/faqs/operations.md plugins: - - search - - mermaid2 - - include-markdown +- search +- mermaid2 +- include-markdown +repo_url: https://github.com/stakater/saap-docs +site_name: Stakater App Agility Platform (SAAP) +site_url: https://docs.stakater.com/saap/ +strict: true +theme: + cloud_security_alliance_logo_dark: assets/images/CSA_dark.png + cloud_security_alliance_logo_light: assets/images/CSA_light.png + custom_dir: dist/_theme + favicon: assets/images/favicon.svg + features: + - content.code.copy + - content.code.select + font: + code: Space Grotesk + text: Space Grotesk + hippa_compliant_logo_dark: assets/images/HC_dark.png + hippa_compliant_logo_light: assets/images/HC_light.png + logo: assets/images/favicon.svg + logo_dark: assets/images/logo-dark.png + logo_light: assets/images/logo-light.png + name: material + palette: + - media: (prefers-color-scheme) + toggle: + icon: material/brightness-auto + name: Switch to system preference + - accent: custom + media: '(prefers-color-scheme: light)' + primary: custom + scheme: default + toggle: + icon: material/brightness-7 + name: Switch to light mode + - accent: custom + media: '(prefers-color-scheme: dark)' + primary: custom + scheme: slate + toggle: + icon: material/brightness-3 + name: Switch to dark mode +use_directory_urls: false diff --git a/prepare_theme.sh b/prepare_theme.sh new file mode 100755 index 00000000..67cf92e0 --- /dev/null +++ b/prepare_theme.sh @@ -0,0 +1,3 @@ +pip install -r theme_common/requirements.txt +python theme_common/scripts/combine_theme_resources.py theme_common/resources theme_override/resources dist/_theme +python theme_common/scripts/combine_mkdocs_config_yaml.py theme_common/mkdocs.yml theme_override/mkdocs.yml mkdocs.yml diff --git a/theme_common b/theme_common new file mode 160000 index 00000000..a17e7ef8 --- /dev/null +++ b/theme_common @@ -0,0 +1 @@ +Subproject commit a17e7ef81d685382bdb5e73f8d9e497946526bc1 diff --git a/theme_override/mkdocs.yml b/theme_override/mkdocs.yml new file mode 100644 index 00000000..dd8857a0 --- /dev/null +++ b/theme_override/mkdocs.yml @@ -0,0 +1,348 @@ +site_name: Stakater App Agility Platform (SAAP) +docs_dir: content +site_url: https://docs.stakater.com/saap/ +repo_url: https://github.com/stakater/saap-docs +edit_uri: blob/main/content/ +use_directory_urls: false +strict: true +theme: + name: material + logo: assets/images/favicon.svg + favicon: assets/images/favicon.svg + custom_dir: dist/_theme + features: + - content.code.copy + - content.code.select + +markdown_extensions: + - admonition + - pymdownx.details + - pymdownx.superfences: + custom_fences: + - name: mermaid + class: mermaid + format: !!python/name:pymdownx.superfences.fence_code_format + - pymdownx.tabbed: + alternate_style: true + - attr_list + - tables + - pymdownx.emoji: + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg + - pymdownx.highlight: + anchor_linenums: true + line_spans: __span + pygments_lang_class: true + - pymdownx.inlinehilite + - pymdownx.snippets + +extra: + analytics: + provider: google + property: G-TTH1YYW5TX + consent: + title: Cookie consent + actions: + - accept + - reject + - manage + description: >- + Stakater uses 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: + - About: + - index.md + - Enterprise Kubernetes: about/saap-vs-k8s.md + - about/saap-features.md + - about/saap-key-differentiators.md + - Service Definition: + - about/service-definition/overview.md + - about/service-definition/platform.md + - about/service-definition/monitoring.md + - about/service-definition/logging.md + - about/service-definition/security.md + - about/service-definition/secrets-management.md + - about/service-definition/service-mesh.md + - about/service-definition/account-management.md + - about/service-definition/networking.md + - about/service-definition/storage.md + - about/responsibilities.md + - Cloud Providers: + - about/cloud-providers/overview.md + - about/cloud-providers/aws.md + - about/cloud-providers/azure.md + - about/cloud-providers/gcp.md + - about/cloud-providers/binero.md + - about/cloud-providers/exoscale.md + - about/update-lifecycle.md + - about/onboarding.md + - For Administrators: + - for-administrators/overview.md + - Plan your environment: + - for-administrators/plan-your-environment/sizing.md + - Secure your cluster: + - for-administrators/secure-your-cluster/user-access.md + - for-administrators/secure-your-cluster/secure-routes.md + - for-administrators/secure-your-cluster/google-idp.md + - for-administrators/secure-your-cluster/azure-idp.md + - for-administrators/secure-your-cluster/keycloak-idp.md + - for-administrators/secure-your-cluster/saml-idp.md + - for-administrators/secure-your-cluster/saap-authorization-roles.md + - for-administrators/secure-your-cluster/curated-list-operators.md + - Manage Network: + - for-administrators/networking/custom-domains.md + - for-administrators/networking/external-dns.md + - Manage Storage: + - for-administrators/storage/volume-expansion.md + - Cluster Lifecycle: + - for-administrators/cluster-lifecycle/hibernate-your-cluster.md + - Help: + - for-administrators/help/faq.md + - Explanation: + - for-administrators/explanation/number-of-clusters.md + - For Delivery Engineers: + - for-delivery-engineers/overview.md + - Explanation: + - for-delivery-engineers/explanation/gitops-intro.md + - for-delivery-engineers/explanation/gitops-structure.md + - for-delivery-engineers/explanation/secrets.md + - for-delivery-engineers/explanation/types-of-environments.md + - for-delivery-engineers/explanation/stakater-tekton-chart.md + - for-delivery-engineers/explanation/faq.md + - Tutorials: + - for-delivery-engineers/tutorials/04-preparing-pac-env/adding-github-token.md + - for-delivery-engineers/tutorials/01-configure-infra-gitops-config/configure-infra-gitops-repo.md + - for-delivery-engineers/tutorials/02-configure-apps-gitops-config/configure-apps-gitops-repo.md + - for-delivery-engineers/tutorials/04-preparing-pac-env/add-ssh-key.md + - for-delivery-engineers/tutorials/03-deploy-demo-app/deploy-demo-app.md + - How-to guides: + - for-delivery-engineers/how-to-guides/configure-repository-secret/configure-repository-secret.md + - for-delivery-engineers/how-to-guides/add-a-cluster-task/add-cluster-task.md + - for-delivery-engineers/how-to-guides/use-a-cluster-task-in-pipeline/use-a-clustertask-in-pipeline.md + - For Developers: + - for-developers/overview.md + - Explanation: + - for-developers/explanation/developer-training.md + - for-developers/explanation/plan-your-deployment.md + - for-developers/explanation/inner-outer-loop.md + - for-developers/explanation/local-development-workflow.md + - for-developers/explanation/production-best-practices.md + - for-developers/explanation/deploying-secrets.md + + - Tutorials: + - Inner Loop: + - for-developers/tutorials/inner-loop/prepare-environment/prepare-env.md + - for-developers/tutorials/inner-loop/about-application/about-application.md + - for-developers/tutorials/inner-loop/access-the-cluster/access-the-cluster.md + - for-developers/tutorials/inner-loop/containerize-app/containerize-app.md + - for-developers/tutorials/inner-loop/package-app/package-app.md + - for-developers/tutorials/inner-loop/deploy-app/deploy-app.md + - for-developers/tutorials/inner-loop/add-secret/add-secrets.md + - for-developers/tutorials/inner-loop/add-configmap/add-configmaps.md + - for-developers/tutorials/inner-loop/configure-probes/configure-probes.md + - for-developers/tutorials/inner-loop/add-storage/persist-app.md + - for-developers/tutorials/inner-loop/expose-app/expose-app.md + - for-developers/tutorials/inner-loop/validate-logs/validate-logs.md + - for-developers/tutorials/inner-loop/monitor-your-app/monitor-your-app.md + - for-developers/tutorials/inner-loop/expose-metrics/expose-metrics.md + - for-developers/tutorials/inner-loop/add-alerts/add-alerts.md + - for-developers/tutorials/inner-loop/synthetic-monitoring/synthetic-monitoring.md + - for-developers/tutorials/inner-loop/add-grafana-dashboard/add-grafana-dashboard.md + - for-developers/tutorials/inner-loop/scale-app/scale-app.md + - for-developers/tutorials/inner-loop/validate-auto-reload/validate-auto-reload.md + - for-developers/tutorials/inner-loop/add-pdb/add-pdb.md + - for-developers/tutorials/inner-loop/add-network-policy/add-network-policy.md + - for-developers/tutorials/inner-loop/tilt-zero-to-hero/step-by-step-guide.md + - Outer Loop: + - for-developers/tutorials/outer-loop/access-cluster/access-the-cluster.md + - for-developers/tutorials/outer-loop/prerequisites.md + - for-developers/tutorials/outer-loop/add-build-environment/add-environment.md + - Configure Pipeline for your application: + - for-developers/tutorials/outer-loop/add-ci-pipeline/01-overview.md + - for-developers/tutorials/outer-loop/add-ci-pipeline/03-create-webhook.md + - for-developers/tutorials/outer-loop/add-ci-pipeline/05-create-repository.md + - Add PipelineRun: + - for-developers/tutorials/outer-loop/add-ci-pipeline/06-adding-pipeline.md + - for-developers/tutorials/outer-loop/add-ci-pipeline/07-add-create-git-tag.md + - for-developers/tutorials/outer-loop/add-ci-pipeline/08-add-create-environment.md + - for-developers/tutorials/outer-loop/add-ci-pipeline/09-add-code-linting.md + - for-developers/tutorials/outer-loop/add-ci-pipeline/10-add-kube-linting.md + - for-developers/tutorials/outer-loop/add-ci-pipeline/11-add-unit-test.md + - for-developers/tutorials/outer-loop/add-ci-pipeline/12-add-sonar-scan.md + - for-developers/tutorials/outer-loop/add-ci-pipeline/13-add-buildah.md + - for-developers/tutorials/outer-loop/add-ci-pipeline/14-add-trivy-scan.md + - for-developers/tutorials/outer-loop/add-ci-pipeline/15-add-rox-image-scan.md + - for-developers/tutorials/outer-loop/add-ci-pipeline/16-add-rox-image-check.md + - for-developers/tutorials/outer-loop/add-ci-pipeline/17-add-rox-deployment-check.md + - for-developers/tutorials/outer-loop/add-ci-pipeline/18-add-checkov-scan.md + - for-developers/tutorials/outer-loop/add-ci-pipeline/19-add-helm-push.md + - for-developers/tutorials/outer-loop/add-ci-pipeline/20-add-update-cd-repo.md + - for-developers/tutorials/outer-loop/add-ci-pipeline/21-add-validate-environment.md + - for-developers/tutorials/outer-loop/promote-application/promote-app.md + - How-to guides: + - for-developers/how-to-guides/add-a-new-environment-to-apps-gitops/add-a-new-environment-to-application.md + - for-developers/how-to-guides/promote-your-application/promote-your-application.md + - for-developers/how-to-guides/build-and-push-your-image/build-and-push-your-image.md + - for-developers/how-to-guides/deploy-app-with-argocd-and-helm/deploy-app-with-argocd-and-helm.md + - for-developers/how-to-guides/expose-spring-boot-metrics/expose-spring-boot-metrics.md + - for-developers/how-to-guides/package-and-push-your-chart/package-and-push-your-chart.md + - For CISOs: + - for-cisos/policies/policies.md + - Red Hat Advanced Cluster Security (RHACS): + - for-cisos/rhacs/introduction.md + - for-cisos/rhacs/accessing-rhacs.md + - for-cisos/rhacs/permissions.md + - Backup and Restore: + - for-cisos/backup-restore/introduction.md + - for-cisos/backup-restore/velero-cli.md + - for-cisos/backup-restore/backup-restore.md + - for-cisos/backup-restore/troubleshooting.md + - for-cisos/backup-restore/cleanup.md + - for-cisos/backup-restore/stateful-app-example.md + - for-cisos/backup-restore/restore-with-gitops.md + - for-cisos/backup-restore/limitations.md + - Data Protection: + - for-cisos/data-protection/gdpr.md + - for-cisos/data-protection/rhacm-data-lifecycle.md + - for-cisos/data-protection/rhacm-data-collection.md + - for-cisos/data-protection/rhacm-data-storage.md + - Managed Addons: + - managed-addons/overview.md + - Nexus: + - managed-addons/nexus/overview.md + - Tutorials: + - managed-addons/nexus/tutorial/login-browse.md + - How-to guides: + - managed-addons/nexus/how-to-guide/how-to-configure-maven-with-nexus.md + - managed-addons/nexus/how-to-guide/how-to-upload-from-ui.md + - managed-addons/nexus/how-to-guide/how-to-upload-local-machine.md + - managed-addons/nexus/how-to-guide/how-to-grant-admin-privileges.md + - Explanation: + - managed-addons/nexus/explanation/routes.md + - managed-addons/nexus/explanation/permissions.md + - Vault: + - managed-addons/vault/overview.md + - ArgoCD: + - managed-addons/argocd/overview.md + - managed-addons/argocd/for-administrators/availability.md + - managed-addons/argocd/for-administrators/installation.md + - managed-addons/argocd/for-administrators/observability.md + - managed-addons/argocd/for-administrators/resource-requirements.md + - Cert Manager: + - managed-addons/cert-manager/overview.md + - External Secrets Operator: + - managed-addons/external-secrets-operator/overview.md + - Forecastle: + - managed-addons/forecastle/overview.md + - Tutorials: + - managed-addons/forecastle/tutorial/add-forecastle-app.md + - Tilt: + - managed-addons/tilt/overview.md + - Renovate: + - managed-addons/renovate/overview.md + - How-to guides: + - managed-addons/renovate/how-to-guides/automerge.md + - managed-addons/renovate/how-to-guides/run-locally.md + - Gatekeeper: + - managed-addons/gatekeeper/overview.md + - Showback: + - managed-addons/opencost/overview.md + - Restful Distributed Lock Manager (RDLM): + - managed-addons/rdlm/overview.md + - Ingress Monitor Controller: + - managed-addons/imc/overview.md + - Tutorials: + - managed-addons/imc/tutorial/add-configuration.md + - managed-addons/imc/tutorial/add-monitors.md + - Konfigurator: + - managed-addons/konfigurator/overview.md + - Explanation: + - managed-addons/konfigurator/explanation/konfigurator-template.md + - managed-addons/konfigurator/explanation/pod-metadata-injector.md + - Logging: + - managed-addons/logging-stack/overview.md + - managed-addons/logging-stack/kibana-view-logs.md + - Monitoring: + - managed-addons/monitoring-stack/overview.md + - managed-addons/monitoring-stack/stack.md + - managed-addons/monitoring-stack/app-uptime.md + - managed-addons/monitoring-stack/app-alerts.md + - managed-addons/monitoring-stack/grafana-dashboard.md + - managed-addons/monitoring-stack/downtime-notifications-uptimerobot.md + - managed-addons/monitoring-stack/log-alerts.md + - managed-addons/monitoring-stack/predefined-prometheusrules.md + - managed-addons/monitoring-stack/workload-application-alerts.md + - Multi Tenant Operator: + - managed-addons/mto/overview.md + - Reloader: + - managed-addons/reloader/overview.md + - Tutorials: + - managed-addons/reloader/tutorial/configure-resources.md + - SonarQube: + - managed-addons/sonarqube/overview.md + - Tekton: + - managed-addons/tekton/overview.md + - Tronador: + - managed-addons/tronador/overview.md + - Velero: + - managed-addons/velero/overview.md + - Volume Expander Operator: + - managed-addons/volume-expander-operator/overview.md + - RHACS: + - managed-addons/rhacs/overview.md + - Vertical Pod Autoscaler (VPA): + - managed-addons/vertical-pod-autoscaler/overview.md + - Horizontal Pod Autoscaler (HPA): + - managed-addons/horizontal-pod-autoscaler/overview.md + - Pelorus: + - managed-addons/pelorus/overview.md + - Service Mesh: + - managed-addons/service-mesh/overview.md + - Patch Operator: + - managed-addons/patch-operator/overview.md + - Ingress Controller: + - managed-addons/ingress-controller/overview.md + - Event Router: + - managed-addons/event-router/overview.md + - Kubernetes Dashboard: + - managed-addons/kubernetes-dashboard/overview.md + - OpenShift Data Foundation: + - managed-addons/odf/overview.md + - Custom Metrics Autoscaler: + - managed-addons/custom-metrics-autoscaler/overview.md + - Dev Spaces: + - managed-addons/devspaces/overview.md + - External DNS: + - managed-addons/external-dns/overview.md + - Helm Leader Chart: + - managed-addons/helm-leader-chart/overview.md + - Web Terminal Operator: + - managed-addons/web-terminal-operator/overview.md + - Legal Documents: + - legal-documents/gtc.md + - legal-documents/sla.md + - legal-documents/agreement.md + - legal-documents/dpa.md + - legal-documents/nda.md + - legal-documents/pp.md + - Help: + - help/support/support.md + - Kubernetes Concepts: + - help/k8s-concepts/storage-basics.md + - help/k8s-concepts/cloud-native-app.md + - help/k8s-concepts/helm.md + - help/k8s-concepts/high-availability.md + - FAQs: + - help/faqs/product.md + - help/faqs/purchasing.md + - help/faqs/customization.md + - help/faqs/developers.md + - help/faqs/operations.md + +plugins: + - search + - mermaid2 + - include-markdown diff --git a/custom_theme/assets/images/favicon.svg b/theme_override/resources/assets/images/favicon.svg similarity index 100% rename from custom_theme/assets/images/favicon.svg rename to theme_override/resources/assets/images/favicon.svg diff --git a/theme_override/resources/assets/images/logo-dark.png b/theme_override/resources/assets/images/logo-dark.png new file mode 100644 index 0000000000000000000000000000000000000000..5750a05415d2fa4047804b0a5f6b72194c019322 GIT binary patch literal 2786 zcmV<83LW){P)oFH(F#bhXn z5kmYKahaA09kGQTns zDsd}>_;FlJT0di3H&c&`iL{*$iN!oh8{JlCs#T;O7n7+F;+x~NJ@T_GU{*g#FS?Dy zwkD*3aK-dgrIWLPqclu`zn{WE@si(y&7Q^IeYI%KOg%0p8;uO<)GR~85%8L&?YtwL z{<&?QaVtoLIP?e1OiAXN@wz!UNo9D~Ca<_H-tQc2T*gJH1Q3^zMiT)^@)ECD zI%-qpG{GQH<^hAM3LUD9cY9I|fQmgik`>p0WQJ7jJ4#F)i%Lm_kuAV}DV)@i!VwCA zW43ZYB~4^?=)isPq@*4flMFI4W601@u-8U2`vVj2dkAWivtVGu9`ej=&&p0JsIM7> z0Is0kg(pZ3=_)fs9DQGsz`TRU*MzTv>TsZDe_E(S@RF!R2D)l_u$)+ z|7En=wxYOA@KeaP)n}$o3Fn+sb_hr(YqZ)*d;0-Yk_(^Y%W6q+d+vCqw=k%k@FA5l z`zp!wK&bQw>dAk))ixZWS1 z`qk>7W$?~?Z~$EWKM3mh24*a2wAb`3Cr1MutNNu}thS5}#HEy0Pf6@Ih_#!F=unJ} z)Vc$H80D^3PlX5YHk*htpM>P~bG3+Ki;^mb*6R64kbNif*9~-_%8CFfiu_&IgPbOj6kenzkn;Nr`MpAfq#zIR})Txfk!bg%bN+s2Ku@=OCV`2vCEf8C|I);2eS;2&L zrc!KbV@VaSGfOGf)tqCMr}GYD2A(1fqb-ISm<1pjtPcZLh)Pdh|_u_x^@-6Yf0Y(#I5Q zU|@jFw0mJ$)yPl5Y!GzPDJ@6 zG0QHhUgoEReW9)mp1Y%Q;0gSKU~?6<>J8M?uELSLhnZPtf zx96-X^UC8*P1;arrH8s>I0uO2Wr#w zHK#fPHY_=7yR)!AXYws~w9kqNVL| z4ZET!=D-mu2m9gFlS~X!a2E0K1Iu+UWe>x2q?FA;s(wF9Opa+&XYhT}*!Gk^BNt5B zR-D~b@OiE}W&7X;T3HX8NqmN0db4#1s&yPYM5kw(%{7bRzXz^BcYPP;Ox=1Wf$XdK z0zHAf<44DP8fqPtw)=X5YyY(Q+O*vvQ#|)jIb-b_n+O#(L)46kSt8Y&S~jMBeSDBH zyju(}{)Revh@2Ek%sA4Xo{algB96-`5vi$V$C7Frd?F`h#r79`fZxp`<1-h`7k0MT^c=Ax zu>%j2jgh)RWY_)GW1JJso5~33!5w&AoSr9^mYbKHzc$W|N#6~SXHF@b)B6=j2zDrt z+%JV#ljM11Txz=Jt`~*H)MyU0fwDPCog&xDF;Ycfg{FW}5)#{*awwG;u7rRon^K7} zWnXF_)i(LYHd1wR=a%%Li(Kl=wFUekFUNO4)ge2U)UpY;Q|D3F(hRiy3MebPu5g~K zaBgnl^WCGmV}3x;H_;y>+uY2ADjQ4a-#gw@rWMz1dlz2e_di3NK(#dhot~Gd>661g zVK%{M)M7J@`u8bhQ&NYV^;Ct6sTnElEEq1};%{IS&5>+gB3DflghGZG zl)q0QdtO6obr0|ObrK?Qrcy`muEG(k;Iii_WxHlOm+VcMtk9W?AvZRwDnrT?+uU*e zl(J_5pCEA+$rUczO8as!&QyT}=h#feVm)ryyx2Nr+h!_v3GvlT9W#9BhT=V9skL_z zG6&FCrDJYMA7Ve_mc6V!*$?chRNW>b<%SiL&0ro&%WJFY%eLxN>wsb zRYG5l;P;^4m!2`-(2@ir$4` zSDOxJT2fgh(63q&dZ!&WOpzwBb%N$LdCz7z@tY9h-wI?85C`dCqz%NRDKknVo(1dG>jBpJ$)FWHz&h$@N#03d;~ zK-%*a%x}d5Li~x&!#40m*~`M-8UTo@06@a9Tesv@%Hz z6Pgu=o)Nci)VM@BtQDkM+d~%y>I&bDT zu2W@QCts}&R@Xb1ovzNRPajHQb*-UvBSJyS;D}A@HP-NnnsC!gdfl_yl ze1}ItdhNolVVqIgvKPwPZ%XEmX|D{-kZGWhd+a0L71$TC*LKaRFQ!MuxvVMSO@>Mx zYKWa%9622&&!}OX`$iw8kquYENcswH2kHYt)G&!PcMo#YMf~NJJ_ZxyK8J=aKG3^! zGid_AcXkMjCeifbqIL@k& zj5=Z)ID!84O9*zKQ4;SWey}7`qlh`mvZI`fi-KZ&#uGrE&2r`+&#Nejtx&z!p-0=5 zuXVL4L@@fdMl(GGe4_?j#B{%s>lq)5!3I&U#xQs_0j^JSr(s|wjz-{qRU zYdKYUwnt-s3-$Z7TQDE_TzFkEr&jT*9OkrA0U>62m2bKmIiOFvn>fNtM9N|RWPs>8{4^pUkHKez;ol?=8w~80!_-4LfgIy z;zWvz!$@AuTsGGaJlV0o7elQOPfhQwYpguISft^#LXdH;s<_;X|3QUazkSG2vNc61 zxuvykuxbv+t>{e|KV0(0#xdWdXIoGwH&4;>{0-hyK_&olz5JMpz+LU*zne!6c{^OL7T2^vRz4mVHw_fck@!dY=UGk(w>O${J zH|k4})CU`%XRax)`*rt)m}dBIEu#7kc9tEoiM=wNNBN|+>9Evh-V2&;f7@h>tMvev zKE}s`)-*+pk95fH&G#}Y)ppjS;S~6jD`nI};pWISPhKo!Id*Cm2eIZJ|AqggPKKK~ zhkJX3`xtoL@Zk#pgTiz)p}LwdsG~O2017wI(T70!3)Ij8mj5pxFxVUC8~y))<>534 oA5i}%AsiRz6Bh0f81i2RVF1 Date: Tue, 21 May 2024 15:46:42 +0500 Subject: [PATCH 2/5] Updated saap docs with theme common --- mkdocs.yml | 2 ++ .../assets/images/footer-logo-dark.png | Bin 0 -> 5315 bytes .../assets/images/footer-logo-light.png | Bin 0 -> 4242 bytes .../resources/assets/images/logo-dark.png | Bin 2786 -> 504 bytes .../resources/assets/images/logo-light.png | Bin 1446 -> 504 bytes 5 files changed, 2 insertions(+) create mode 100644 theme_override/resources/assets/images/footer-logo-dark.png create mode 100644 theme_override/resources/assets/images/footer-logo-light.png diff --git a/mkdocs.yml b/mkdocs.yml index 0c6ad8f3..173952ec 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -344,6 +344,8 @@ theme: font: code: Space Grotesk text: Space Grotesk + footer_logo_dark: assets/images/footer-logo-dark.png + footer_logo_light: assets/images/footer-logo-light.png hippa_compliant_logo_dark: assets/images/HC_dark.png hippa_compliant_logo_light: assets/images/HC_light.png logo: assets/images/favicon.svg diff --git a/theme_override/resources/assets/images/footer-logo-dark.png b/theme_override/resources/assets/images/footer-logo-dark.png new file mode 100644 index 0000000000000000000000000000000000000000..a138c75a4210b608e3378e4a04e6c83ef2808bf5 GIT binary patch literal 5315 zcmV;!6g=yRP)}`DL4@X-Y?xd}?g!@)BH9HE^_U8~$ zJLe}5R>c@m3Dj0k9gr`Er^2_*Y=^473w^!ZI8_VFs2N(2KN~pN&K1Y*!$%c#GEDVo zGcq>ml)@5)1q(`$KR7rQox>(uhfkh0nH8OA6e~=PAU^{OvHN-UeA-O*G$=I>8aNe1 z0B09qla*_+=d#WgcekdFQ$d7iy$jisS%-r#uxBs;`@NY3Y=s_e=US;SZ2~wu$DRxq zv2O=Rm*d1#;~5woU)NeH_QBT}dfeZ;8>y>Tkj(4F+_j+o50PuTUe!*X!nmGcR@=xZru35!NDQJ#l_{+qmMp%>FCj;%BH5K%QZDM@5IH$SsThL9pgJ zo;?Hb`--WJq?_=0MU~v~@P1xI#4zUgaDU|)bhjz#!H~xVSo|KMbt*07Vs9@(0{fSc z;e(-pB_ueg)cLW|m4gENEB!2F&v%UZy2Qxyon}Vm?u38ZAA!$ZOUkILs|$gyS11(o zxQ3}zzA*oZ2#_{W&CAOhU?^WzRn-iz@ZOe|mNW2cbCCZmg04e|#HV&e-{6MKsjjX* z0)1cqT6%i=!>Df)eCcnSo15!sbOUQph~G!hmdD%i%XiRVNXw_*#0N*G;iDfnvbzw9 zI*y@lGCq)E(eDz}wHIv*Fp}?OerFB>V@{@x>8h8L4R-G2 zjGj?flGZ2RubJt4Qud^Gjb;!=r~el=*_4o!xGL;(Ae0(IWME9J_Vv z*6kzI70#zig(cX)2b|*&3{Hc;Jq>N#3SawGyk#_JjRX2S5o7Qy+@xpWPHn{T8wM;I-L$4-`(;5vfhXqXB%>RTh;-~@4^K}T zjh=S2xBuM6#=2OqJo=u5mEN`k_dXFO>_AS=)vrt%Sw{2%KBQq-?u{_$^o@`9o2Ft9%YD80cXp8`~KFmPr8 zVeHtkbZg0W|Ni}ByuH1TgE`N@Z+%h=D9Ws?EV@uhNlD27Pft&}@-KsJ*2Kofo=8qk zR;tsMmzVcNu(b!1I2vsH873{lz*Y{obAgF6=(_+|FJsbo@W7nl>+4&lVGN}*3II$- zU)SX4=YJFs5Kyic9FBB%cRz~p=n1A=3V^eZ_kDa)eH zFG@>GUj?{y>H--I#CYw;JPkv8b^?s^^y-Pj*J_MsJjxi41vMUR+KO>Wj*N`V0{g3U z24L8*Asjd@iFjICRR4SBN{$Kl!xo+Hb&N?A}FMZhFWX{86e$21vtC-XeR;*Z&ym|BHCi6(2RgX<7CT&7{=>Wj7OP4PF z4xls`K!GJZFp(Ef#=|)|IU@j|i>89JqM~9Um~k5z`No|)cgAZ2lV3=p?c2Ba_w)11 zYp;C(QXm%4MSwzvx?OW~b5-Vo6JXmRl}f2u-iNV`YHz{s+_}>>Dk>@iX@_F5P6ulr z(FZ5yqYMBR!wm{U-_GeE<)KV$N88U~P&1)9r%s(ZG<){! z2VDV9Qv{Q{9uu~-zP>&YZo@KDzzJY3#^n8-0uu{v0**^8tshL41BM+0mZIBiXUzfU zk3atSFc`4_aKB5m!zHc*n^yqQea6rU}HsfPYOLKE* zZA~rFS6Qu$`*!#6AcOqpcMgJA9e&xKK(T;!Y^UgePOnP4fxNe3<0xsD~Vye z@x8Fapk1jXdAYfqs-;#|3vfD-I+?kCJ=@4XjEqIWzDBr5-hLvAYFWL))k*huek)U2 zSv(sEKBx)&h-zYDqSNBVi${P-M`1-z275dPKX3?D_&y5&(r5<yzEDWRN3?4k#Dm68A9Zcd9 z_=n9Xs}}+o8i?&OmJjUo5+*#Bnr)bGIqJ$rUClV>IdbI4oj6wo=Id~)4pzpXdBQ@o z2ICVfG&DAn=9U(sgpb|9%g|PW^x1=_XNOT3vho7pd4PeZe7;KjT;rH!|K3+1A`G1_=8DibyQYb zTG|$XaUt04B*47}ApHiQ*Z@F$k20>d<6E!6wUq$ScL3MSUAuPu3rwwfJ1{ddvrqs2 z{e!Sj-bEWdjMa~N4H6cBr{cl;1KOo|Wd?22Jg83RmBu3gEsc~^U|IF0a~9koViBM) ztLTmlG2_7o>bmFV{eVD;p(~0sDiki%pI0grXy7jkxM98?;_QNZow~(1WXO=}l9H0w zdiCmc4nESO@$vC4t5>f!$!DRP$N=3AfZFx$-McejeoyF`*%ky6mvDFqV?<4}(am@Y zOaMGNCMM=(8u|)NDr8MSbb?{cre#-}3=82@DMEPA#P=`DV?UH42P06pJ)PAD9+K)Y|~CX!SM? z7%>@4^#tmO+_r7oCV(?WFYx#q?+db*p@ z5u;$V=`fo{ZHs!EL9**5S|)uFm^y0WP$#@PoD;+a4y-LH_7`SE0D+5(bRd5kE0GDx#zE=JXa62XBgIaZi`94YUX zN&Y|QZIW;xh#b1Gn3Pjj$#bpFf7{V5)V3?T?Y;Gi8acUMRLQBL$uxolgRR2^{u9yZ zyE2)~q{wu{h!KhEXmrb#Ee!_Dn!){4_=M#=8x4oqbTYE<=L*(&%j~&2|5;9>TnGzXC(kq@P zjomkr#%j`j{L%tP8rPfq{);51Jw%3#o=U=Jg_BjQR*~6r=8)j=VI=8GFGBkK+bB2< zMvnlbtX{#XiZ#ujmCNN9&@UMVaTNwB8%};a7$*pzWehOiUogQ3=)G?m9mC<*2N26o z+6efiToef3Pf}G?HNBvqpvS<01J5G}NC$)Yf=&KzXulL?j>EMS0Kb|abJxj}C%4ys zX*>Id-_a-b5zzDigY8wHFDolMLht&3Ri~mKOZEF$TwLr1le`-BA3_ArJ)s5AjM}_; zv(9!F@)q-pZ8`cm2Em*c7F%d#W#voiG$`YJ^kF}k*DoL-;9Gj#0K-1+30ZE4wiOLc`*s_HsjHr#edvs^RBj&JJC9Ldx1gkiWam{Y4556L-Jog>;iz7!2 zmP2*=jG62wNl6F^V!1rZG;#z~xj-vT$jP;l&z}3>TovFC4!h$&nbw%DHzREcLJ493v z-M7p1v9Yld%Iq{9fbpjKe0h2KWVByS&!ehrdIt(^jYnPo#QFO;z6TJ`LY`oCJ*law zI!{#<78VYs{bTin-Vq853)4g&{{H?9`jtq}^VhRc?q@LLpQCMA^c)sLJ&u>rv<56t z98E)?_%aGiG^kfWVPUnCiz^2ZsjVHmZ258yWKnaU=g!RvpUplU8pbLr)7X0_QTBN~ zaApwhe7&rUb#eFL@`$X&?21*Z*fVF&uyOJ6EF%)JUJvzVUyXT(m;xO?4!DLlx4?HIEE>dsu7nCg$ho z2OGTAR9fl>iO~zpnmE~^=YsDXwTymm>83%I=TxHy8Dw)H0-uIE?#HV zOqn{3bp?CIERJOx<<%Sr_1UxTKZLD5J)AvzHbYa+D+?Ctl(Y2h<=pw`S7X@o=g+h3 zH4QkQZ;xqB&>HBGR!}qkrus9>mM!z7tdWqA;AP0ncd##NJ$m$LTVrXWqobt&&5*pj zyZ{_a$gd!1=kNNzOvU^TzE?@fPk%u)e*8F{M8QEpDaiGco!kPim{Osr+9rnkDPk zuP>u&$)KgDr+4^Qkz2QJZGv9@H76JCZ2H}U6OL_B@7_PL`>B+#$b^s(&2E3{nKV9V zD5nomG*u|bCi*h3llt##n$_k&VdLQBsCjHI{oAu-$(tINh#dH|^>%elZRcm*w{O;sc8tR?%kUvjJhBu$)!t|9Kd=94<0(i_U_}W z1E`6U9;e$#E%)!=k2a+&M8u+fE`hUWR3u2ZWJ$lquE|)K< zuBo{}w|`PnzG5>kT%d36eS@&ytf!W$tE*=M>}RsGv$?ILi&?P)XJgc;V zfETD06(L2d90GF5C4{RGNJ4;c<=CBm@BIJ3W|_^-EF@5v_j$f&c6a_`=AZZf{_pr_ z0Uthm`0(MwhYue1@4+ z$1LiCoW#Q-pNb3=nF{4(xkBo`@YHZ1lF!fWTQ))A_I+5mWFwFcbZpriUyZ&q*Dibh zU1Qe5$1#JtB4@sqE+Q9;Om|zcG87zR7{ROT?-64!A`(u@NJ)j6ni^entw<~QIA-A5 z<}_y@rR?+2L(|8kc7S(KQ;yP~ABGPfF5p^o8keG~VzzOM5sb)!iiPlwDIzPOv}aeS zW!^KIG^~gE_0o_U^n>xoIy^n$lpr={gm4y;#{>E}6iFhKnt}#G&h)fY9K&b}HHlBf zaSTu7Gy>+Pj5OnCQ(izlBnNuxUyA$~YVeN~8j17~c}Zk}$TE?+P}==&sMKpba1+Ya zsNL(oOJs(~uTb|m0qXwF!x4rjhbR&@N;5MMYPc)4owzCs;2jlEwkLz~)SmgMdyssO zK@rpmzYy62wIAS7k^jb==R+O!r@DhJeXtu z4(i5#h`Pl?B7YNMl756pCy@qFTL)=Np9@9EQjt4FzS3oV907RqDoiX*4{_UCpxeiz z>*pN8@^0Il!%=t0)%`Jo&&?>bf9Hwp(&x)X=0imjIznmJ&-Cv;jsU#HIU^`&*nn!r zxFQrR-x5M9X1s`f!64QLgXY#MU*e#62;qhTM`NdaoR~u z-~o5)BbV#>3Cb2jX<2`>$`OP&avGtMpizNyzi)t%93iE6@J6~}Sl(sZ@`@@inv@#q zZ740;)orE9sxbDJS0V|t*2n+2uVUHAHfW<#quOy^ngLy+&VM7~v@4%8=qDmMA`CGU zi7Y{K;ka1vn#BHxx_pqb^T0guDAA7{TeJ+h9za zW*ayB6eB)5>hdhNE2>Za&edv`H*%g^R%*;ky{mqD^pEELZN%y6nR4;_+_v^Fs0Y+V zOTJSfiL1UG2}hlinP9R@u@WO@>-2p``+S93=9d$a;7KiEs^+)5Im835DoaSiXz; z+#M=xM#t)TsLk5zpx&u!udm@o{h1`+0&h4CDh1pE2fqgM1QhWY8sqB3@hyZR=|v*X ziS!pa6V+F&FZBJ9lw8f0pn5iMW6U+&3`KIPrWdqq)ctT$aN==-{1j?DHp3Yt^{Y^! zy+VDxy!M)x^{lKcyG$3jgkcz6B9X{t9XfRAws7IXl?jSZfEtL)pgi|Eu?0*saHS~A ztE&BG^<(vQ&?|aoI84pxL{1Lmy-*J{AL;=zu2}(hSgXaxCMc3Sf%n0X87E&+%sGbO z7{BD? zd&AqyheSZvp~kxn2NTlx!hlXHCRiIg~HQC3!l z!oor@Z^(ElAQ1W&Q218HqZHPDzrJ}1hF@hdS8wt0G$Lu3ftLWM2T%A{<5hGbXBm>j{P_pM zho)&Z>nKQ6XZP;i)WmzJk)gsf3CVdFK}Y0mEwqnLhFXF+%X39Ogd*(}cn595zEA`| zG3FedF>3K~eQ_LO z$yt`DQZ(oV<|B!`>c))+96GT*hX_H3R8>`hQc+PM9`;`A7!HR~Sy^cb&++?F0_M@5 zf=aQ{sp13RvgDPVc7B?1JUU{uYpFeGGEtL}a5N=;kf0sLF!P~8QF%~K)<`I_E{{{^ zw<3RlBI1*}ELQGuq@<+m zCm)H&aMZ~spX^v(94_SM=2}kHnl)>%e!bV|POX7<3O#8CwrO8c!?_LjFt$ZIibgR5 z_RAc~FpfuW_ai8WC?4{lq5^yd_C}l6L`Fj`ud(q%nj<9dVyN)VMu#@3HJ^pDuhZcj z^ysOXISHOZEg~K{8Qp&QhART6i{Ig4>r@4*M`i+O)TjiF8#!ynb~#}=$5pBXZJU;% zyh9MLzkk$d(dbA6mm|02q*KQwoley<92#hoc7f8m1f3X??s}*=;>eit*XiT$;Y`fK z0ea_oP#U;aQKM>qozR2EG_y>!!xH73SxNjZuHPD1E} zo(N{Pff11;#U6>Xmc9jLn=6>6J93&)p1R@gA_!_iI$dt#nzo(D&b+Afw)(inMcG8l z+|xKfOdAX#amyit?Ig;~sB@?3W1?&sO^algb;d9`DH#4?_%G3cq)v9-xGY)`utJ9pRo2S}0zNAZpflsA7KbIM-8;Ag9F zY0rP+rUA1td0|f&XNqD8<-#kLt=)=mR&K(o4aIJ&kTA?(FkR|)CAeQ7xtuzMl;Ulr zv(u4XP%~&YU7Vnd)9~_I^7LnJVu^OP3S9O*42j7ZZ^@@N=cHi-fSSA}4$+BYE}xUT z1w0~d!=jxA%v_XxONX;Bz`%h6F>Ts3eDcXB7(93|?jJG|>#O>rqCszz?r^4OSPX;0 zViWbx9EZ_w7NdLjD=})+D9oHW6XVB^N8i4E@xZVbQGTlU8lje`WpE<_`On)2<_Q4I$e8Au8-?HHi zpXvG>xW}V@AE%Gpf#tO9+722+c5C%-v0Jq9p^v?SCx$!TTFCi&?2kX+Pc zS-Kv{LM_36qE%R3I=ANR@%uby;S>-b_GEC8$RvQHc1!mi}ZB6m)&Edm`n;X`zHX{of zo8hlR^k7HW{X%6R#wQ^Rurq(1>2P}-FlsesE4Z11Wa7hM4xA5;T9cZsQ4K>xjWR>m zq0N;KrD>ygA5mkFl)Lr4(C%8P@6V1s=0a)muVdP$Crnc1p=NL!;5^+=wDx7Jc8>0o zeecwLF!pH^jS(3JreA>b{gI@!n@C1R7k&fhG5ICbSnSY!(P?0Wfs^wB#K&t;_jm@p zK=?DdM~@yBK_o?KN?6FWA==8!$;mPM_3LN$?%mrgUOLDkV)^U?ZvVJQqoU@?xcnwwAn>y$XTg#_Ld3m{&Z{MgZBzwXg++`CLrGXZ%lF17oc{TR7hY(!GiAyYOrNg)g@(iy z&1-$84co3=yRcCaZWjpFW9*Kavy}^>!OeIdjqRhEm_80CWYx_U(v-Gn(PICyN&7G@ zEp7jI$?TZhwryJ{WlyT1o$Dt}nj}7ovA2tc4LC?N;y5ILw80?LCc15>t-MAe; zPulqwK77O=p&KIPV!Vs7tj@YTLlW-@p*$JC(hkEO3~_L?ERA$-GM**vMBu}R4<9~! o`0(MwhYue5A#HoPf#S>gX>A(^Vu!H8J)#)5A zBs`F^(#Fc2cV~BQ_8bIfJKG5?JmlriyX&z$rs4xGb>i#G$CuYX0TsYZ9!1Y~DZUW! z&L`J}CtxCvrT9wxnaeS|z7@~7mY=Ls0iB~8S0@$&sk~GF8Wi10f~{v!1-nI2wL0@w z{0(cm;LuU^OgvG`EfYa7Z4W3wHl*BT0DO@6)ecmG@N#2;xdH)vzXv!|g(Bxrt-)3j zzc8R11qk`C34*{IiX~S2sjpI5Or`QqLQ4qXK6M1fRIjNTXPqB#=7@i1;dLZGS89LZ z3PM-n7>AS$pz4N~#g9f-O8y;3T4{YkQNa+@M4eefrhIHS-;r93J*x(#BT@`2FfycY zpBYxRkqVA^3HVqh;3GvDy502A&4Q*zhyZ<3`^$a6pi;b|f&-p&&T}4+?n;AGy$$!j z$IgrllsUI91SJ08{~_rqIpm#VEDA-Tnd{b?eJH*Rt^0MRgr$RPg0&u>z8U8_u$sut uCot^!q8L$hzO(2!!{nG8XZv6FCBOjAr@_c6EAmhP0000oFH(F#bhXn z5kmYKahaA09kGQTns zDsd}>_;FlJT0di3H&c&`iL{*$iN!oh8{JlCs#T;O7n7+F;+x~NJ@T_GU{*g#FS?Dy zwkD*3aK-dgrIWLPqclu`zn{WE@si(y&7Q^IeYI%KOg%0p8;uO<)GR~85%8L&?YtwL z{<&?QaVtoLIP?e1OiAXN@wz!UNo9D~Ca<_H-tQc2T*gJH1Q3^zMiT)^@)ECD zI%-qpG{GQH<^hAM3LUD9cY9I|fQmgik`>p0WQJ7jJ4#F)i%Lm_kuAV}DV)@i!VwCA zW43ZYB~4^?=)isPq@*4flMFI4W601@u-8U2`vVj2dkAWivtVGu9`ej=&&p0JsIM7> z0Is0kg(pZ3=_)fs9DQGsz`TRU*MzTv>TsZDe_E(S@RF!R2D)l_u$)+ z|7En=wxYOA@KeaP)n}$o3Fn+sb_hr(YqZ)*d;0-Yk_(^Y%W6q+d+vCqw=k%k@FA5l z`zp!wK&bQw>dAk))ixZWS1 z`qk>7W$?~?Z~$EWKM3mh24*a2wAb`3Cr1MutNNu}thS5}#HEy0Pf6@Ih_#!F=unJ} z)Vc$H80D^3PlX5YHk*htpM>P~bG3+Ki;^mb*6R64kbNif*9~-_%8CFfiu_&IgPbOj6kenzkn;Nr`MpAfq#zIR})Txfk!bg%bN+s2Ku@=OCV`2vCEf8C|I);2eS;2&L zrc!KbV@VaSGfOGf)tqCMr}GYD2A(1fqb-ISm<1pjtPcZLh)Pdh|_u_x^@-6Yf0Y(#I5Q zU|@jFw0mJ$)yPl5Y!GzPDJ@6 zG0QHhUgoEReW9)mp1Y%Q;0gSKU~?6<>J8M?uELSLhnZPtf zx96-X^UC8*P1;arrH8s>I0uO2Wr#w zHK#fPHY_=7yR)!AXYws~w9kqNVL| z4ZET!=D-mu2m9gFlS~X!a2E0K1Iu+UWe>x2q?FA;s(wF9Opa+&XYhT}*!Gk^BNt5B zR-D~b@OiE}W&7X;T3HX8NqmN0db4#1s&yPYM5kw(%{7bRzXz^BcYPP;Ox=1Wf$XdK z0zHAf<44DP8fqPtw)=X5YyY(Q+O*vvQ#|)jIb-b_n+O#(L)46kSt8Y&S~jMBeSDBH zyju(}{)Revh@2Ek%sA4Xo{algB96-`5vi$V$C7Frd?F`h#r79`fZxp`<1-h`7k0MT^c=Ax zu>%j2jgh)RWY_)GW1JJso5~33!5w&AoSr9^mYbKHzc$W|N#6~SXHF@b)B6=j2zDrt z+%JV#ljM11Txz=Jt`~*H)MyU0fwDPCog&xDF;Ycfg{FW}5)#{*awwG;u7rRon^K7} zWnXF_)i(LYHd1wR=a%%Li(Kl=wFUekFUNO4)ge2U)UpY;Q|D3F(hRiy3MebPu5g~K zaBgnl^WCGmV}3x;H_;y>+uY2ADjQ4a-#gw@rWMz1dlz2e_di3NK(#dhot~Gd>661g zVK%{M)M7J@`u8bhQ&NYV^;Ct6sTnElEEq1};%{IS&5>+gB3DflghGZG zl)q0QdtO6obr0|ObrK?Qrcy`muEG(k;Iii_WxHlOm+VcMtk9W?AvZRwDnrT?+uU*e zl(J_5pCEA+$rUczO8as!&QyT}=h#feVm)ryyx2Nr+h!_v3GvlT9W#9BhT=V9skL_z zG6&FCrDJYMA7Ve_mc6V!*$?chRNW>b<%SiL&0ro&%WJFY%eLxN>wsb zRYG5l;P;^4m!2`-(2@ir$4` zSDOxJT2fgh(63q&dZ!&WOpzwBb%N$LdCz7z@tY9h-wI?85C`dCqz5A#HoPf#S>gX>A(^Vu!H8J)#)5ABs`F^(#Fc2cV~BQ_8bIfJKG5?JmlriyX&z$ zrs4xGb>i#G$CuYX0TsYZ9!1Y~DZUW!&L`J}CtxCvrT9wxnSaYMyS^3AxR#%+Qvsc$ z8&@Y51F5`I{~8qCNrJ6sQ3bn2QMEerR{RZXy5P`J^-Mfb%PkW@Fl`SgKsKb@WdMAT z_|*C%|Sxlw!PeMxw z;68N(##FDV8h>YUMpjDx9Yv$4A?YbO(-imD83A>`*o&-rGsmNwH}|o8Rt5%n#j#3FzorF7*TY-v*;@ zl>va12mm_(&*uSv00)3Y4*<}=2LRF`g-!Nncn<+DD>D?p{Y%9yr8&GrFx4GG!r_4Mf7SgB<-uo_zHS@i9US}sGLQqba(_&Lll-VUCHtc?D;Sv2eLMecmy zd^h@Crn5i)YIT&n%0QD8d!iH|P>`BFhRDx^rYYJPXrn7k3Tf4AWM;EnNJkCBM&j zXP}2of&@Ikhuq7E&mynvn^T|9j6vAUX~8YJQk}){KwfdgOr#9GhJN-dZG=Js4OYWq z^km(Ct`7`RK_}MS5oM!Nq}6YqLooXcleiafLnRSv zMT{|~eeT(~NI2SeA_3~vENupUIH#l_vP$;ZfFEgByxP?!OQ82}k7auD`9%)8ifDf! z)zd!|%j-wJ9M5j=S89%Lc(~l}Xk{44AWJ4Wd+AEC`^p2uk`sui5eX!>(Cl_`@9Z{$6HHFiZ6I`Uk53q5=M8$z>3kp8X2%MYU)CmeMZ&ED0Vs(ia6;P0XSA9o8EBAy9u z$mP_^U6DqgQYef9V^`K#cUvDVL_p7c8-#Xg*p0XPF-Al<@179{D$&p0r&Ea-8+>GJ zOphV7YlYKOTcwjtMMhvPKP_Yd0=f1q!gA_L6sKS_P@1&->PLWUIgHul$<$aLy16l6 z8P&4(7PDQ2khdPdbgtqSLl9cXytp?76BG(xlVUE_4(zKSPNujzj^@|QXS4m~r#klc zqRADI)b!rE#>!JmMQYxwQIalI6_4Fhe}@C zIu#iA?C@*l<;z)~yUu;W&j6rqmp=AwZQG!p@K3cTjO<{Q@4oB_)>0fzYTA?-c9;z+ zp*mEifqlWgNW2sJ3T-KsKgt^W+};ht>_fH|e;ZFm8Qp*VZl! zRwmq=&8!!g_8%vGRkD(6>NR(3zxHZYL3aBX;2qMGdFo>C3wQDhsQ7zZ-=}UVullw3 zg_vXnY%f{#iFTG9v;{BEbt2rxIP@IucZfr^A5OyIilcSL=fHw>lY0m{tvJ`lm_Dgs{d4kV}pFd!aajR c{>$j-!!`ddF})^A!tfx#!qgT;H};7C6GC^U7XSbN From 7ae79148ee11e67cd18c3788ca1290104af48bb4 Mon Sep 17 00:00:00 2001 From: RSAK56 Date: Tue, 21 May 2024 15:57:58 +0500 Subject: [PATCH 3/5] Updated readme fix --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c1e689e6..308c2c93 100644 --- a/README.md +++ b/README.md @@ -86,7 +86,7 @@ $ tilt up Files `main.html` and `404.html` are served from `theme_common` rather than override since they are to be consistent throughout. If anything changes they can be served via `theme_override`. -To execute the prepare theme command after setup you need to add the `prepare_theme.sh` or copy paste bash file using sudo cmd file to your root directory and then run the following cmd: +To execute the prepare theme command after setup you need to add the `prepare_theme.sh` or copy and paste bash file using sudo cmd file to your root directory and then run the following cmd: ```bash $ chmod +x preparetheme sh From 586d30c22c88c60503aea27ab51f943caed3fc08 Mon Sep 17 00:00:00 2001 From: RSAK56 Date: Tue, 21 May 2024 16:02:23 +0500 Subject: [PATCH 4/5] Updated readme added punctuation after finally --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 308c2c93..a8e5aa88 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,7 @@ Install mkdocs-include-markdown-plugin (if not installed by default and gives an $ pip install mkdocs-include-markdown-plugin ``` -Finally serve the docs using the built-in web server which is based on Python http server - note that the production build will use Nginx instead: +Finally, serve the docs using the built-in web server which is based on Python http server - note that the production build will use Nginx instead: ```bash $ mkdocs serve From 6423c2d3d2f7dce8f35417bc1c27c3aa6850d473 Mon Sep 17 00:00:00 2001 From: RSAK56 Date: Tue, 21 May 2024 17:48:02 +0500 Subject: [PATCH 5/5] Modified docker file structure and removed unused properties from yaml --- Dockerfile | 6 +++--- mkdocs.yml | 13 +------------ theme_override/mkdocs.yml | 16 ---------------- 3 files changed, 4 insertions(+), 31 deletions(-) diff --git a/Dockerfile b/Dockerfile index caaae7a6..00f0c224 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,6 +1,6 @@ FROM python:3.12 as builder -RUN pip3 install mkdocs-material mkdocs-mermaid2-plugin mkdocs-table-reader-plugin mkdocs-include-markdown-plugin +RUN pip3 install mkdocs-mermaid2-plugin mkdocs-table-reader-plugin mkdocs-include-markdown-plugin # set workdir RUN mkdir -p $HOME/application @@ -10,10 +10,10 @@ WORKDIR $HOME/application COPY --chown=1001:root . . # build the docs +RUN chmod +x prepare_theme.sh && ./prepare_theme.sh RUN mkdocs build - FROM nginxinc/nginx-unprivileged:1.26-alpine as deploy -COPY --from=builder $HOME/application/site/ /usr/share/nginx/html/saap/ +COPY --from=builder $HOME/application/site/ /usr/share/nginx/html/ COPY default.conf /etc/nginx/conf.d/ # set non-root user diff --git a/mkdocs.yml b/mkdocs.yml index 173952ec..ff82bf2a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -9,7 +9,7 @@ extra: - accept - reject - manage - description: Stakater uses cookies to recognize your repeated visits and preferences, + 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. @@ -17,20 +17,10 @@ extra: extra_css: - stylesheets/extra.css markdown_extensions: -- admonition -- pymdownx.details -- pymdownx.superfences: - custom_fences: - - class: mermaid - format: !!python/name:pymdownx.superfences.fence_code_format '' - name: mermaid - pymdownx.tabbed: alternate_style: true - attr_list - tables -- pymdownx.emoji: - emoji_generator: !!python/name:material.extensions.emoji.to_svg '' - emoji_index: !!python/name:material.extensions.emoji.twemoji '' - pymdownx.highlight: anchor_linenums: true line_spans: __span @@ -326,7 +316,6 @@ nav: - help/faqs/developers.md - help/faqs/operations.md plugins: -- search - mermaid2 - include-markdown repo_url: https://github.com/stakater/saap-docs diff --git a/theme_override/mkdocs.yml b/theme_override/mkdocs.yml index dd8857a0..1d859833 100644 --- a/theme_override/mkdocs.yml +++ b/theme_override/mkdocs.yml @@ -36,22 +36,6 @@ markdown_extensions: - pymdownx.inlinehilite - pymdownx.snippets -extra: - analytics: - provider: google - property: G-TTH1YYW5TX - consent: - title: Cookie consent - actions: - - accept - - reject - - manage - description: >- - Stakater uses 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: - About: - index.md