Skip to content

Commit efae973

Browse files
committed
Fixed documentation Markdown lint warnings
1 parent 2f4e8c6 commit efae973

File tree

3 files changed

+9
-7
lines changed

3 files changed

+9
-7
lines changed

docs/_coverpage.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1+
<!-- markdownlint-disable MD041 -->
12
<!-- _coverpage.md -->
23

34
![logo](./images/ipam-logo.png ':size=45%')
45

56
# IPAM <small>3.5.0</small>
7+
68
> Azure IP Address Management Made Easy
79
810
[GitHub](https://github.com/Azure/ipam)

docs/deployment/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ To successfully deploy the solution, the following prerequisites must be met:
2424
- [Docker (Linux)](https://docs.docker.com/engine/install/) / [Docker Desktop (Windows)](https://docs.docker.com/desktop/install/windows-install/) installed (optional)
2525
- Required only if you are building your own container image and running it locally for development/testing purposes
2626

27-
> **NOTE:** An alternate [Management Group](https://learn.microsoft.com/en-us/azure/governance/management-groups/overview) can be specific, but is **highly discouraged** as it will limit the visibility of the Azure IPAM platform. This option should only be used for testing or proof-of-concept deployments.
27+
> **NOTE:** An alternate [Management Group](https://learn.microsoft.com/azure/governance/management-groups/overview) can be specific, but is **highly discouraged** as it will limit the visibility of the Azure IPAM platform. This option should only be used for testing or proof-of-concept deployments.
2828
2929
## Deployment Overview
3030

@@ -61,7 +61,7 @@ Connect-AzAccount
6161
Connect-AzAccount -UseDeviceAuthentication
6262
```
6363

64-
> **NOTE:** If you're connecting to an Azure Cloud besides Azure Public (such as Gov, China, etc.), you may need to specify the `-Environment` flag as described [here](https://learn.microsoft.com/powershell/azure/authenticate-azureps#sign-in-to-another-cloud) when using `Connect-AzAccount`
64+
> **NOTE:** If you're connecting to an Azure Cloud besides Azure Public (such as Gov, China, etc.), you may need to specify the `-Environment` flag as described in the [Authentication Methods](https://learn.microsoft.com/powershell/azure/authenticate-azureps#sign-in-to-another-cloud) documentation when using `Connect-AzAccount`
6565
6666
### Set the Active Subscription for Azure PowerShell
6767

@@ -76,7 +76,7 @@ Set-AzContext -Subscription "28b502e2-323f-4e57-98db-743459176557"
7676
Set-AzContext -Subscription "Contoso IPAM Subscription"
7777
```
7878

79-
For additional information on authenticating with Azure PowerShell, refer to the documentation [here](https://learn.microsoft.com/powershell/azure/authenticate-azureps)
79+
For additional information on authenticating with Azure PowerShell, refer to the [documentation](https://learn.microsoft.com/powershell/azure/authenticate-azureps)
8080

8181
## Authenticate to Azure CLI (Optional)
8282

@@ -105,7 +105,7 @@ az account set --subscription "28b502e2-323f-4e57-98db-743459176557"
105105
az account set --subscription "Contoso IPAM Subscription"
106106
```
107107

108-
For additional information on authenticating with Azure CLI, refer to the documentation [here](https://learn.microsoft.com/cli/azure/authenticate-azure-cli)
108+
For additional information on authenticating with Azure CLI, refer to the [documentation](https://learn.microsoft.com/cli/azure/authenticate-azure-cli)
109109

110110
## Clone the Github Repo
111111

@@ -126,7 +126,7 @@ PS /ipam/deploy> .\deploy.ps1 <OPTIONS>
126126
To deploy the full solution, run the following from within the `deploy` directory:
127127

128128
```powershell
129-
./deploy.ps1 -Location "westus3"
129+
./deploy.ps1 -Location "westus3"
130130
```
131131

132132
You have the ability to pass optional flags to the deployment script:
@@ -149,7 +149,7 @@ You have the ability to pass optional flags to the deployment script:
149149
150150
> **NOTE 3:** Maximum of seven (7) characters. This is because the prefix is used to generate names for several different Azure resource types with varying maximum lengths.
151151
152-
> **NOTE 4:** It is **highly discouraged** to use a [Management Group](https://learn.microsoft.com/en-us/azure/governance/management-groups/overview) other than the [Root Management Group](https://learn.microsoft.com/azure/governance/management-groups/overview#root-management-group-for-each-directory) as it will limit the visibility of the Azure IPAM platform. This option should only be used for testing or proof-of-concept deployments.
152+
> **NOTE 4:** It is **highly discouraged** to use a [Management Group](https://learn.microsoft.com/azure/governance/management-groups/overview) other than the [Root Management Group](https://learn.microsoft.com/azure/governance/management-groups/overview#root-management-group-for-each-directory) as it will limit the visibility of the Azure IPAM platform. This option should only be used for testing or proof-of-concept deployments.
153153
154154
**Customize the name of the App Registrations:**
155155

docs/troubleshooting/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,6 @@ az cosmosdb update --resource-group <ResourceGroupName> --name <CosmosDBAccountN
132132

133133
### <u>Notes</u>
134134

135-
This flag may have been set by [Azure Policy](https://learn.microsoft.com/azure/governance/policy/overview). You can find more details about this policy [here](https://learn.microsoft.com/azure/cosmos-db/policy-reference#azure-cosmos-db) under *Azure Cosmos DB key based metadata write access should be disabled*. You may need to contact your policy administrator to request an exception for Azure IPAM.
135+
This flag may have been set by [Azure Policy](https://learn.microsoft.com/azure/governance/policy/overview). You can find more details about this policy in the [Azure Policy Built-Ins](https://learn.microsoft.com/azure/cosmos-db/policy-reference#azure-cosmos-db) documentation under *Azure Cosmos DB key based metadata write access should be disabled*. You may need to contact your policy administrator to request an exception for Azure IPAM.
136136

137137
Additionally this issue only applies to legacy deployments of Azure IPAM (prior to v3.0.0) as the latest versions use SQL [role-based access control](https://learn.microsoft.com/azure/cosmos-db/how-to-setup-rbac) to read/write data from Cosmos DB.

0 commit comments

Comments
 (0)