revert "ci: add markdown-link-check workflow (#715)" (#717)

This reverts commit e4e3d61. Signed-off-by: Anish Ramasekar <anish.ramasekar@gmail.com>
Azure · Nov 12, 2021 · 7e3bd77 · 7e3bd77
1 parent e4e3d61
commit 7e3bd77
Show file tree

Hide file tree

Showing 10 changed files with 50 additions and 93 deletions.
diff --git a/.github/workflows/markdown-link-check.yaml b/.github/workflows/markdown-link-check.yaml
diff --git a/docs/remote-devcontainer.md b/docs/remote-devcontainer.md
@@ -32,17 +32,17 @@ The [VS Code Remote Container Extension](https://code.visualstudio.com/docs/remo
 1. Open up the project in VS Code.
 2. In the bottom-left corner of VS Code click on the remote window icon as shown below:
 
-    ![open a remote window icon](./images/bottom-left.png)
+    ![open a remote window icon](/docs/images/bottom-left.png)
 
 3. Select `Remote-Containers: Reopen in Container` from the drop-down list
 
-    ![Reopen in Container](./images/reopen-container.png)
+    ![Reopen in Container](/docs/images/reopen-container.png)
 
 4. The Azure Key Vault Provider should now be opened inside a Remote Container!
     - In the bottom-left you should see the tag updated to show: `Dev Container: Secrets Store CSI Driver Provider Azure`
     - Open the [integrated terminal](https://code.visualstudio.com/docs/editor/integrated-terminal) with `ctrl + `\`.
     - You can open up a bash shell in the container such as shown below:
 
-    ![remote dev container](./images/container_open.png)
+    ![remote dev container](/docs/images/container_open.png)
 
 Your Environment is now set up using the VS Code Remote Devcontainer Extension.
diff --git a/examples/kind/README.md b/examples/kind/README.md
@@ -12,9 +12,9 @@
 
 - Follow the [instructions](https://azure.github.io/secrets-store-csi-driver-provider-azure/configurations/identity-access-modes/service-principal-mode/) to set up Service Principal and give it access to Azure Key Vault. Keep `ClientID` and `ClientSecret` of the Service Principal handy.
 
-- Copy [v1_secretproviderclass.yaml](https://raw.githubusercontent.com/Azure/secrets-store-csi-driver-provider-azure/master/examples/service-principal/v1alpha1_secretproviderclass_service_principal.yaml) and [pod-inline-volume-service-principal.yaml](https://raw.githubusercontent.com/Azure/secrets-store-csi-driver-provider-azure/master/examples/service-principal/pod-inline-volume-service-principal.yaml) to this directory.
+- Copy [v1alpha1_secretproviderclass.yaml](https://raw.githubusercontent.com/Azure/secrets-store-csi-driver-provider-azure/master/examples/service-principal/v1alpha1_secretproviderclass_service_principal.yaml) and [pod-secrets-store-inline-volume-secretproviderclass.yaml](https://raw.githubusercontent.com/Azure/secrets-store-csi-driver-provider-azure/master/examples/service-principal/pod-secrets-store-inline-volume-secretproviderclass.yaml) to this directory.
 
-- Update `v1_secretproviderclass.yaml` to provide keyvault name and keyvault resources to fetch.
+- Update `v1alpha1_secretproviderclass.yaml` to provide keyvault name and keyvault resources to fetch.
 
 ```yaml
 cloudName: 'AzurePublicCloud' # [OPTIONAL available for version > 0.0.4] if not provided, azure environment will default to AzurePublicCloud

diff --git a/website/README.md b/website/README.md
@@ -14,7 +14,7 @@ Before making your first contribution, make sure to review the [Contributing Gui
 
 The Azure Key Vault Provider for Secrets Store CSI Driver docs are built using [Hugo](https://gohugo.io/) with the [Docsy](https://docsy.dev) theme, hosted using [GitHub Pages](https://pages.github.com/).
 
-The [website](./) directory contains the hugo project, markdown files, and theme configurations.
+The [website](./website) directory contains the hugo project, markdown files, and theme configurations.
 
 ## Pre-requisites
 
@@ -24,49 +24,36 @@ The [website](./) directory contains the hugo project, markdown files, and theme
 ## Environment setup
 
 1. Ensure pre-requisites are installed
-1. Clone this repository
-
+2. Clone this repository
 ```sh
 git clone https://github.com/Azure/secrets-store-csi-driver-provider-azure.git
 ```
-
-1. Change to website directory
-
+3. Change to website directory: 
 ```sh
 cd website
 ```
-
-1. Add Docsy submodule
-
+4. Add Docsy submodule: 
 ```sh
 git submodule add https://github.com/google/docsy.git themes/docsy
 ```
-
-1. Update submodules
-
+5. Update submodules: 
 ```sh
 git submodule update --init --recursive
 ```
-
-1. Install npm packages
-
+6. Install npm packages: 
 ```sh
 npm install
 ```
 
 ## Run local server
-
 1. Make sure you're still in the `website` directory
-1. Start the local server
-
+2. Run 
 ```sh
 hugo server --disableFastRender
 ```
-
-1. Navigate to `http://localhost:1313/docs`
+3. Navigate to `http://localhost:1313/docs`
 
 ## Update docs
-
 1. Create new branch
 1. Commit and push changes to content
 1. Submit pull request to `master`

diff --git a/website/content/en/configurations/identity-access-modes/_index.md b/website/content/en/configurations/identity-access-modes/_index.md
@@ -8,11 +8,10 @@ description: >
 ---
 
 ## Best Practices
-
 Following order of access modes is recommended for Secret Store CSI driver AKV provider:
 
-| Access Option                                          | Comment                                                                                                                                                                                                                                                        |
-| ------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| Pod Identity                                           | This is the most secure way to get access to Azure resources (AKV in this case) as it uses the managed identity bound to the Pod.                                                                                                                              |
-| Managed Identities (System-assigned and User-assigned) | Managed identities eliminate the need for developers to manage credentials. Managed identities provide an identity for applications to use when connecting to Azure Keyvault.                                                                                  |
-| Service Principal                                      | This is the last option to consider while connecting to AKV as access credentials need to be created as Kubernetes Secret and stored in plain text in etcd.<br>Also, this is the only option to connect to Azure resources from non Azure environment/cluster. |
+| Access Option 	| Comment 	|
+|---	|---	|
+| Pod Identity 	| This is the most secure way to get access to Azure resources (AKV in this case) as it uses the managed identity bound to the Pod. 	|
+| Managed Identities (System-assigned and User-assigned) 	| Managed identities eliminate the need for developers to manage credentials. Managed identities provide an identity for applications to use when connecting to Azure Keyvault. 	|
+| Service Principal 	| This is the last option to consider while connecting to AKV as access credentials need to be created as Kubernetes Secret and stored in plain text in etcd.<br>Also, this is the only option to connect to Azure resources from non Azure environment/cluster. 	|
diff --git a/website/content/en/configurations/ingress-tls.md b/website/content/en/configurations/ingress-tls.md
@@ -47,11 +47,11 @@ helm repo add csi-secrets-store-provider-azure https://raw.githubusercontent.com
 helm install csi csi-secrets-store-provider-azure/csi-secrets-store-provider-azure --set secrets-store-csi-driver.syncSecret.enabled=true
 ```
 
-Refer to [installation](../getting-started/installation/_index.md) for more details and validation.
+Refer to [installation](../../getting-started/installation) for more details and validation.
 
 ### Optional: Deploy AAD Pod Identity
 
-If using AAD pod identity to access Azure Keyvault, make sure it is [configured properly](https://azure.github.io/aad-pod-identity/docs/demo/standard_walkthrough/) in the cluster. Refer to [doc](../configurations/identity-access-modes/pod-identity-mode.md) on how to use AAD Pod identity to access keyvault.
+If using AAD pod identity to access Azure Keyvault, make sure it is [configured properly](https://azure.github.io/aad-pod-identity/docs/demo/standard_walkthrough/) in the cluster. Refer to [doc](../identity-access-modes/pod-identity-mode) on how to use AAD Pod identity to access keyvault.
 
 ```bash
 export AAD_POD_IDENTITY_NAME=azure-kv
@@ -68,10 +68,10 @@ kubectl create ns $NAMESPACE
 
 ### Create the SecretProviderClass
 
-* To provide identity to access key vault, refer to the following [section](../configurations/identity-access-modes/_index.md).
+* To provide identity to access key vault, refer to the following [section](../identity-access-modes).
 * Set the `tenantId` and `keyvaultName`
 * If using **AAD pod identity** to access Azure Key Vault - set `usePodIdentity: "true"`
-* Use `objectType: secret` for the certificate, as this is the only way to retrieve the certificate and private key from azure key vault as documented [here](../configurations/getting-certs-and-keys.md)
+* Use `objectType: secret` for the certificate, as this is the only way to retrieve the certificate and private key from azure key vault as documented [here](../getting-certs-and-keys)
 * Set secret type to `kubernetes.io/tls`
 
 ```bash
@@ -162,7 +162,7 @@ controller:
 EOF
 ```
 
-If not using [service principal mode](../configurations/identity-access-modes/service-principal-mode.md), remove the following snippet from the script:
+If not using [service principal mode](../identity-access-modes/service-principal-mode), remove the following snippet from the script:
 
 ```bash
             nodePublishSecretRef:
@@ -200,7 +200,7 @@ Depending on the TLS certificate lifecycle, follow one of the following steps:
               name: secrets-store-creds
 ```
 
-If not using [service principal mode](../configurations/identity-access-modes/service-principal-mode.md), remove the following snippet from [deployment-app-one.yaml](https://raw.githubusercontent.com/Azure/secrets-store-csi-driver-provider-azure/master/docs/sample/ingress-controller-tls/deployment-app-one.yaml) and [deployment-app-two.yaml](https://raw.githubusercontent.com/Azure/secrets-store-csi-driver-provider-azure/master/docs/sample/ingress-controller-tls/deployment-app-two.yaml)
+If not using [service principal mode](../identity-access-modes/service-principal-mode), remove the following snippet from [deployment-app-one.yaml](https://raw.githubusercontent.com/Azure/secrets-store-csi-driver-provider-azure/master/docs/sample/ingress-controller-tls/deployment-app-one.yaml) and [deployment-app-two.yaml](https://raw.githubusercontent.com/Azure/secrets-store-csi-driver-provider-azure/master/docs/sample/ingress-controller-tls/deployment-app-two.yaml)
 
 ```yaml
             nodePublishSecretRef:

diff --git a/website/content/en/demos/standard-walkthrough/_index.md b/website/content/en/demos/standard-walkthrough/_index.md
@@ -31,7 +31,7 @@ helm repo add csi-secrets-store-provider-azure https://raw.githubusercontent.com
 helm install csi csi-secrets-store-provider-azure/csi-secrets-store-provider-azure
 ```
 
-Refer to [installation](../../getting-started/installation/_index.md) for more details and validation.
+Refer to [installation](../../getting-started/installation) for more details and validation.
 
 ### 2. Create Keyvault and set secrets
 
@@ -52,7 +52,7 @@ az keyvault secret set --vault-name ${KEYVAULT_NAME} --name secret1 --value "Hel
 
 Refer to [Identity Access Modes](../../configurations/identity-access-modes) to see the list of supported modes for accessing the Key Vault instance.
 
-In this walkthrough, we will be using the [Service Principal](../../configurations/identity-access-modes/service-principal-mode.md) auth mode for accessing the Key Vault instance we just created.
+In this walkthrough, we will be using the [Service Principal](../../configurations/identity-access-modes/service-principal-mode) auth mode for accessing the Key Vault instance we just created.
 
 ```bash
 # Create a service principal to access keyvault

diff --git a/website/content/en/getting-started/installation/_index.md b/website/content/en/getting-started/installation/_index.md
@@ -45,7 +45,7 @@ helm install csi csi-secrets-store-provider-azure/csi-secrets-store-provider-azu
 
 The helm charts hosted in [Azure/secrets-store-csi-driver-provider-azure](https://github.com/Azure/secrets-store-csi-driver-provider-azure/tree/master/charts/csi-secrets-store-provider-azure) repo include the Secrets Store CSI Driver helm charts as a dependency. Running the above `helm install` command will install both the Secrets Store CSI Driver and Azure Key Vault provider.
 
-> Refer to [doc](../../configurations/deploy-in-openshift.md) for installing the Azure Key Vault Provider for Secrets Store CSI Driver on Azure RedHat OpenShift (ARO)
+> Refer to [doc](../../configurations/deploy-in-openshift) for installing the Azure Key Vault Provider for Secrets Store CSI Driver on Azure RedHat OpenShift (ARO)
 
 ##### Values
 
@@ -134,7 +134,7 @@ If you deployed the Secrets Store CSI Driver and Azure Key Vault provider using
 helm delete <release name>
 ```
 
-> Refer to [doc](../../configurations/deploy-in-openshift.md) to uninstall the Azure Key Vault Provider for Secrets Store CSI Driver on Azure RedHat OpenShift (ARO)
+> Refer to [doc](../../configurations/deploy-in-openshift) to uninstall the Azure Key Vault Provider for Secrets Store CSI Driver on Azure RedHat OpenShift (ARO)
 
 ##### Using deployment yamls