Skip to content

Commit 8d84d9c

Browse files
authored
Merge pull request Azure#356 from necusjz/fix-rendering
fix rendering issue
2 parents d2e768c + 37ec675 commit 8d84d9c

1 file changed

Lines changed: 10 additions & 9 deletions

File tree

docs/README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ The degree of coupling between commands relay on SDK can be seen from the follow
6262
![BumpUpNetworkSDK](assets/images/az_cli_bump_up_network_sdk.png)
6363
The SDK packages a batch of APIs, and when one API has new change and is released in a new SDK version,
6464
we have to test and update the commands that use the whole batch of APIs in SDK instead of the one API we care about.
65-
Each time we bump up a SDK, hundreds of tests need to rerun in live and their recording files need to be updated, we also need to fix other commands that are broken by new SDK.
65+
Each time we bump up an SDK, hundreds of tests need to rerun in live and their recording files need to be updated, we also need to fix other commands that are broken by new SDK.
6666
It wasted a lot of time and created a lot of hidden problems. By applying Atomic CLI commands, we can avoid them.
6767

6868
## Overview
@@ -73,7 +73,7 @@ AAZDev Tool consists of 4 parts:
7373
- API Translators:
7474
They are responsible for translating the API specification into a command model. We've implemented the swagger 2.0 translator which can support to translate the API specs in [azure-rest-api-specs](https://github.com/Azure/azure-rest-api-specs) repo and [azure-rest-api-specs-pr](https://github.com/Azure/azure-rest-api-specs-pr) repo.
7575
- Model Editors:
76-
They are used to edit command models. Currently _Workspace Editor_ is implemented. More details are introduced in _Workspace_ paragraph.
76+
They are used to edit command models. Currently, _Workspace Editor_ is implemented. More details are introduced in _Workspace_ paragraph.
7777
- Command Models:
7878
The command models generated from translators and modified in editors will be persisted in a repo called AAZ. The persistence of models can be useful in many ways. More details are introduced in _AAZ Repo_ paragraph.
7979
- Code Generators:
@@ -89,9 +89,10 @@ A Resource can be translated into a single command or multiple commands under a
8989

9090
Swagger V2 translator uses the `valid part` of url to generate the group part of a command.
9191

92-
The `valid part` of url is the url suffix starts by it's Resource Provider with parameter placeholders replaced by `{}` and locations segment removed.
92+
The `valid part` of url is the url suffix starts by its Resource Provider with parameter placeholders replaced by `{}` and locations segment removed.
9393

9494
The table below show some examples with valid part highlighted.
95+
9596
| Resource Provider | Resource Url | valid part of url |
9697
| ---- | ---- | ---- |
9798
| Microsoft.EdgeOrder | /subscriptions/{subscriptionId}/providers/**Microsoft.EdgeOrder/addresses** | Microsoft.EdgeOrder/addresses |
@@ -108,7 +109,7 @@ Each segments of valid part corresponds to a group name. The parameter segments
108109

109110
Swagger V2 translator use the HTTP methods to generate the operation part of a command.
110111

111-
The table below show the mapping relation ship between the common command operation name and the resource HTTP methods.
112+
The table below show the mapping relationship between the common command operation name and the resource HTTP methods.
112113

113114
| Common Command Operation Name | Resource HTTP Method |
114115
| ---- | ---- |
@@ -119,7 +120,7 @@ The table below show the mapping relation ship between the common command operat
119120
| update (by generic) | GET + PUT |
120121
| update (by patch) | PATCH |
121122

122-
For example if a resource has following properties:
123+
For example if a resource has the following properties:
123124

124125
```yaml
125126
resource_id: '/subscriptions/{}/resourcegroups/{}/providers/microsoft.edgeorder/addresses/{}'
@@ -160,7 +161,7 @@ methods:
160161
- GET
161162
```
162163

163-
Translators will automatic merge them into one `list` commands if their response schemas are the same. If their response schemas are different, a special suffix will be added after `list` operation name to distinguish two commands. And the name can be renamed in editor.
164+
Translators will automatically merge them into one `list` commands if their response schemas are the same. If their response schemas are different, a special suffix will be added after `list` operation name to distinguish two commands. And the name can be renamed in editor.
164165

165166
The `POST` method is special. If a resource has `POST` method only and the last segment of valid part is not a parameter segment, that segment will be used as operation name, else a temporary name will be generated, which can be renamed in editor later.
166167

@@ -169,7 +170,7 @@ The `POST` method is special. If a resource has `POST` method only and the last
169170
Before developers finish customizing the command models and export them in AAZ repo for persistence, the draft is saved in a workspace.
170171
Workspaces are like containers, they are isolated so that changes in one do not affect the others. Therefore, developers can create as many workspaces as needed for different purposes.
171172

172-
It's possible to add resources from different resource providers, but they should be in the same plane. Currently we only support Management plane.
173+
It's possible to add resources from different resource providers, but they should be in the same plane. Currently, we only support Management plane.
173174
Another note is that a workspace don't allow to add a resource multiple times in different versions. For example, if virtual network resource('/subscriptions/{}/resourcegroups/{}/providers/microsoft.network/virtualnetworks/{}') of version 2021-05-01 is added in a workspace, it's not allowed to add other versions of this resource in this workspace.
174175

175176
Please jump to [Workspace Editor](pages/usage/workspace_editor_usage.md) for more details.
@@ -178,7 +179,7 @@ Please jump to [Workspace Editor](pages/usage/workspace_editor_usage.md) for mor
178179

179180
The name __AAZ__ comes from the abbreviation of Atomic Azure. This repo is to maintain Atomic Azure Cli command models. You can access this repo by [link](https://github.com/Azure/aaz/tree/main).
180181

181-
There a two folders in the root of AAZ:
182+
There are two folders in the root of AAZ:
182183

183184
- Commands:
184185
This folder provides an index of command models available in AAZ. They are organized in a command tree.
@@ -214,7 +215,7 @@ The diagram below show the structure of command configuration file.
214215

215216
The commands in a configuration file organized in hierarchy.
216217

217-
There are three sections in every commands:
218+
There are three sections in every command:
218219

219220
- Argument Section:
220221
The arguments defined in argument section and grouped by Argument Group.

0 commit comments

Comments
 (0)