diff --git a/src/portal/README.rst b/src/portal/README.md similarity index 81% rename from src/portal/README.rst rename to src/portal/README.md index 7085dff35ef..8e8c168f4f2 100644 --- a/src/portal/README.rst +++ b/src/portal/README.md @@ -15,7 +15,7 @@ Manage Azure portal dashboards: [more info](https://docs.microsoft.com/en-us/azu #### Import a portal dashboard #### -You should have a dashboard json template before using this operation, the file can be downloaded from Azure portal website. +You should have a dashboard json template ready before using this operation, the file can be downloaded from Azure portal website. More info can be found [here](https://docs.microsoft.com/en-us/azure/azure-portal/azure-portal-dashboards-create-programmatically#fetch-the-json-representation-of-the-dashboard) Example: ``` @@ -25,7 +25,7 @@ az portal dashboard import \ --input-path "/path/to/dashboard/template/file/directory" ``` An example dashboard JSON template may look like: -[dashboard.json](https://github.com/Azure/azure-cli-extensions/tree/master/src/portal/azext_portal/tests/latest/dashboard.json) +[dashboard.json](https://github.com/Azure/azure-cli-extensions/blob/master/src/portal/azext_portal/tests/latest/dashboard.json) #### Create a portal dashboard #### Example: @@ -38,7 +38,7 @@ az portal dashboard create \ --tags aKey=aValue anotherKey=anotherValue ``` An example propeties JSON file may look like: -[properties.json](https://github.com/Azure/azure-cli-extensions/tree/master/src/portal/azext_portal/tests/latest/properties.json) +[properties.json](https://github.com/Azure/azure-cli-extensions/blob/master/src/portal/azext_portal/tests/latest/properties.json) #### List all portal dashboards #### Example: @@ -72,7 +72,9 @@ az portal dashboard update \ #### Delete a dashboard #### Example: ``` -az portal dashboard update \ +az portal dashboard delete \ --name dashboardName \ --resource-group groupName \ ``` + +If you have issues, please give feedback by opening an issue at https://github.com/Azure/azure-cli-extensions/issues. \ No newline at end of file diff --git a/src/portal/setup.py b/src/portal/setup.py index 7ca593a2770..d5d78350f42 100644 --- a/src/portal/setup.py +++ b/src/portal/setup.py @@ -35,7 +35,7 @@ # TODO: Add any additional SDK dependencies here DEPENDENCIES = [] -with open('README.rst', 'r', encoding='utf-8') as f: +with open('README.md', 'r', encoding='utf-8') as f: README = f.read() with open('HISTORY.rst', 'r', encoding='utf-8') as f: HISTORY = f.read()