Skip to content

Change portal README file from rst to markdown #1589

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
YalinLi0312 merged 2 commits into from
Apr 23, 2020
Merged

Change portal README file from rst to markdown #1589

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
76322a2
Change portal README file from rst to markdown
Apr 23, 2020
0c50717
Update related chnage in setup.py
Apr 23, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions src/portal/README.rst → src/portal/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
```
Expand All @@ -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:
Expand All @@ -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:
Expand Down Expand Up @@ -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.
2 changes: 1 addition & 1 deletion src/portal/setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand Down