diff --git a/.github/workflows/closed_pr.yaml b/.github/workflows/closed_pr.yaml index da7ae497b..9ef76ea54 100644 --- a/.github/workflows/closed_pr.yaml +++ b/.github/workflows/closed_pr.yaml @@ -7,6 +7,6 @@ on: jobs: push: - uses: stakater/.github/.github/workflows/pull_request_closed.yaml@v0.0.103 + uses: stakater/.github/.github/workflows/pull_request_closed.yaml@v0.0.105 secrets: GH_TOKEN: ${{ secrets.PUBLISH_TOKEN }} diff --git a/.github/workflows/delete_branch.yaml b/.github/workflows/delete_branch.yaml index f8827ec44..5eae0a8a0 100644 --- a/.github/workflows/delete_branch.yaml +++ b/.github/workflows/delete_branch.yaml @@ -4,7 +4,7 @@ on: delete jobs: delete: - uses: stakater/.github/.github/workflows/branch_deleted.yaml@v0.0.103 + uses: stakater/.github/.github/workflows/branch_deleted.yaml@v0.0.105 with: LATEST_DOC_VERSION: "1.0" secrets: diff --git a/.github/workflows/pull_request.yaml b/.github/workflows/pull_request.yaml index 38664b2b9..bb2623724 100644 --- a/.github/workflows/pull_request.yaml +++ b/.github/workflows/pull_request.yaml @@ -4,23 +4,23 @@ on: pull_request: branches: - "main" - - "[0-9]+.[0-9]+" + - "^[0-9]+.[0-9]+$" jobs: doc_qa: - uses: stakater/.github/.github/workflows/pull_request_doc_qa.yaml@v0.0.103 + uses: stakater/.github/.github/workflows/pull_request_doc_qa.yaml@v0.0.105 with: MD_CONFIG: .github/md_config.json DOC_SRC: content README.md MD_LINT_CONFIG: .markdownlint.yaml deploy_doc: - uses: stakater/.github/.github/workflows/pull_request_versioned_doc.yaml@v0.0.103 + uses: stakater/.github/.github/workflows/pull_request_versioned_doc.yaml@v0.0.105 secrets: GH_TOKEN: ${{ secrets.PUBLISH_TOKEN }} build_container: needs: deploy_doc if: ${{ github.base_ref == 'main' }} - uses: stakater/.github/.github/workflows/pull_request_container_build.yaml@v0.0.103 + uses: stakater/.github/.github/workflows/pull_request_container_build.yaml@v0.0.105 with: DOCKER_BUILD_CONTEXTS: content=https://github.com/stakater/mto-docs.git#pull-request-deployments DOCKER_FILE_PATH: Dockerfile diff --git a/.github/workflows/push.yaml b/.github/workflows/push.yaml index ceff3e06d..ed624f8a1 100644 --- a/.github/workflows/push.yaml +++ b/.github/workflows/push.yaml @@ -4,11 +4,11 @@ on: push: branches: - "main" - - "[0-9]+.[0-9]+" + - "^[0-9]+.[0-9]+$" jobs: push: - uses: stakater/.github/.github/workflows/push_versioned_doc.yaml@v0.0.103 + uses: stakater/.github/.github/workflows/push_versioned_doc.yaml@v0.0.105 with: LATEST_DOC_VERSION: "1.0" secrets: diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index a3169ddcf..cf5c1623b 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -7,11 +7,11 @@ on: jobs: create_release: - uses: stakater/.github/.github/workflows/release_template.yaml@v0.0.103 + uses: stakater/.github/.github/workflows/release_template.yaml@v0.0.105 secrets: SLACK_WEBHOOK_URL: ${{ secrets.STAKATER_DELIVERY_SLACK_WEBHOOK }} build_container: - uses: stakater/.github/.github/workflows/push_container_only.yaml@v0.0.103 + uses: stakater/.github/.github/workflows/push_container_only.yaml@v0.0.105 with: DOCKER_BUILD_CONTEXTS: content=https://github.com/stakater/mto-docs.git#gh-pages DOCKER_FILE_PATH: Dockerfile diff --git a/README.md b/README.md index 2e0d7d807..f656e8c15 100644 --- a/README.md +++ b/README.md @@ -2,25 +2,30 @@ This repository contains the source for the documentation for [Multi Tenant Operator](https://www.stakater.com/mto). It is built using [MkDocs](https://github.com/mkdocs/mkdocs) which is based on Python. It is also versioned using [mike](https://github.com/jimporter/mike). -## Latest doc version - -Before deploying or deleting a version, make sure to specify the correct latest version in the workflow files. - -Make sure the latest doc version is also specified in the versioned branches. - ## GitHub Actions This repository has [GitHub action workflow](./.github/workflows/) which checks the quality of the documentation and builds the [`Dockerfile`](./Dockerfile) image on Pull Requests. On a push to the `main` branch, it will create a GitHub release and push the built image to an image repository. ## How to make changes -Fork the repository and make a pull request. +1. Fork the repository +1. Make a pull request +1. Workflow will run QA checks, make sure all jobs have succeeded before requesting a review +1. Pull requests builds are published for review on `https://stakater.github.io/mto-docs//` +1. On merge of a pull request, the documentation is published on [`docs.stakater.com/mto/`](https://docs.stakater.com/mto/) -For MkDocs overrides, it is important to know that you should only make changes in the [`theme_override`](./theme_override/) and the [`content`](./content/) directory. Also, be mindful of only changing the [`theme_override/mkdocs.yml`](./theme_override/mkdocs.yml) file since there are more than one such file. +> [!NOTE] +> For MkDocs overrides, it is important to know that you should only make changes in the [`theme_override`](./theme_override/) and the [`content`](./content/) directory. +> +> Be mindful of only changing the [`theme_override/mkdocs.yml`](./theme_override/mkdocs.yml) file since there are more than one such file. +> +> Before deploying or deleting a version, make sure to specify the correct latest version in the workflow files. +> +> Make sure the latest doc version is also specified in the versioned branches. -## Take update on git submodule +### Update git submodule -This project contains a git submodule and if you wish to take an update on it, you can use this command: +This project contains a git submodule and if you need to update it, use this command: ```bash git submodule update --init --recursive --remote @@ -90,7 +95,7 @@ brew install markdownlint-cli markdownlint -c .markdownlint.yaml content ``` -Spell checking: +To run spell checking: ```bash brew install vale diff --git a/content/installation/managed-kubernetes/azure-aks.md b/content/installation/managed-kubernetes/azure-aks.md index 46a1d9612..5583aa439 100644 --- a/content/installation/managed-kubernetes/azure-aks.md +++ b/content/installation/managed-kubernetes/azure-aks.md @@ -116,15 +116,15 @@ az role assignment create --assignee $OPSSRE_ID --role "Azure Kubernetes Service ### Create test users in `Entra ID` -Set User Principal Name (UPN) and password for your users. The UPN must include the verified domain name of your tenant, for example user@company.com. +Set User Principal Name (UPN) and password for your users. The UPN must include the verified domain name of your tenant, for example `user@company.com`. -Following command reads the UPN for the appdev group and stores it in the AAD_DEV_UPN variable: +Following command reads the UPN for the appdev group and stores it in the `AAD_DEV_UPN` variable: ```terminal echo "Please enter the UPN for application developers: " && read AAD_DEV_UPN ``` -For this scope of this blog, we will assume that the entered UPN was aksdev@company.com. +For this scope of this blog, we will assume that the entered UPN was `aksdev@company.com`. Following command reads the password for your user and stores it in the AAD_DEV_PW variable: @@ -146,13 +146,13 @@ az ad group member add --group appdev --member-id $AKSDEV_ID Repeat the steps for `OPS SRE` user. -The following command reads the UPN for your user and stores it in the AAD_SRE_UPN variable: +The following command reads the UPN for your user and stores it in the `AAD_SRE_UPN` variable: ```terminal echo "Please enter the UPN for SREs: " && read AAD_SRE_UPN ``` -For this scope of this blog, we will assume that the entered UPN was opssre@company.com. +For this scope of this blog, we will assume that the entered UPN was `opssre@company.com`. The following command reads the password for your user and stores it in the AAD_SRE_PW variable: diff --git a/theme_common b/theme_common index 112feae9f..55af314d8 160000 --- a/theme_common +++ b/theme_common @@ -1 +1 @@ -Subproject commit 112feae9fae3cdfe8d63c9a0c0471e1e89c22865 +Subproject commit 55af314d81692aece306ad4f06290124bef55ee0