Cleanup of docs(migration, docker) (#4316)

* Clenaup of docs

* Migrate summary

* Docker images tweaks
This commit is contained in:
Timothee Guerin 2021-10-01 15:46:28 -07:00 коммит произвёл GitHub
Родитель e4d28e3a86
Коммит 212956caf0
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
4 изменённых файлов: 26 добавлений и 17 удалений

Просмотреть файл

@ -2,12 +2,11 @@
This is a table tracking the implementation of new features across Autorest generators and which version there were added.
| Feature | Core Version | Modelerfour version | Python | CSharp | Java | Typescript | Go | Swift |
| ---------------------------------------- | ------------ | ------------------- | ------- | ----------------------------------- | ---- | ---------- | --- | ----- |
| [`AnyObject` vs `Any`][any-feat] | | `4.19.0` | `5.8.0` | `v3.0.0-beta.20210428.3` |
| [Security standarization][security-feat] | | `4.19.0` | | [WIP: PR#1128][security-csharp-wip] |
| Feature | Core Version | Modelerfour version | Python | CSharp | Java | Typescript | Go | Swift |
| ---------------------------------------- | ------------ | ------------------- | ------- | ----------------------- | ---- | ---------- | --- | ----- |
| [`AnyObject` vs `Any`][any-feat] | | `4.19.0` | `5.8.0` | `3.0.0-beta.20210428.3` |
| [Security standarization][security-feat] | | `4.19.0` | | `3.0.0-beta.20210620.8` |
| [Deprecation][deprecation-feat] | | `4.19.0` |
| [Header ignore][header-ignore] | | `4.20.0` |
<!-- Feature links -->

Просмотреть файл

@ -2,12 +2,13 @@
AutoRest provide some docker images:
| Image | Description | Ubuntu |
| -------------------------- | --------------------------------------------- | ------------------ |
| `azuresdk/autorest` | Base image with node installed | :heavy_check_mark: |
| `azuresdk/autorest-python` | Base image + python 3 For building python sdk | :heavy_check_mark: |
| `azuresdk/autorest-dotnet` | Base image + dotnet. For building csharp sdk | :heavy_check_mark: |
| `azuresdk/autorest-java` | Base image + java. For building java sdk | :heavy_check_mark: |
| Image | Description | Image size | Ubuntu |
| -------------------------- | ------------------------------------------------------------------- | ---------------------------------------------------------------------- | ------------------ |
| `azuresdk/autorest` | Base image with node installed | ![](https://img.shields.io/docker/image-size/azuresdk/autorest) | :heavy_check_mark: |
| `azuresdk/autorest-python` | Base image + python 3 For building python sdk | ![](https://img.shields.io/docker/image-size/azuresdk/autorest-python) | :heavy_check_mark: |
| `azuresdk/autorest-dotnet` | Base image + dotnet. For building csharp sdk | ![](https://img.shields.io/docker/image-size/azuresdk/autorest-dotnet) | :heavy_check_mark: |
| `azuresdk/autorest-java` | Base image + java. For building java sdk | ![](https://img.shields.io/docker/image-size/azuresdk/autorest-java) | :heavy_check_mark: |
| `azuresdk/autorest-all` | Base image with all the languages for building any of the sdk above | ![](https://img.shields.io/docker/image-size/azuresdk/autorest-all) | :heavy_check_mark: |
## Usage

Просмотреть файл

@ -2,8 +2,7 @@
## General Guidance
First, make sure when generating you are using AutoRest V3. Follow the steps in [our installation section][install] for information on upgrading
and confirming your new AutoRest version.
First, make sure when generating you are using AutoRest V3. Follow the steps in [our installation section][install] for information on upgrading and confirming your new AutoRest version.
## New Features
@ -11,15 +10,19 @@ and confirming your new AutoRest version.
AutoRest 3.0 finally supports OpenAPI3 files as an input format, with the following caveats:
- existing AutoRest v2 generators may not support all features from OpenAPI3. (see next section)
- `anyOf`, `oneOf` are not currently supported
- other OpenAPI3 specific features may not be entirely supported.
### Generators
### Generators - **Breaking**
A new set of language generator plugins are being written that adopt the lighter-weight patterns for Azure Core libraries.<br>
Existing V2 generators will default to processing with the AutoRest 2 pipeline. <br>
See the language generator flags [here][language_flags]
**The older generators are only compatible with Autorest V2.**
| Generator | Packages names | Autorest Core |
| ----------- | -------------------------------------- | ------------- |
| V2 (Track1) | `@microsoft.azure/autorest.<language>` | `2.x` |
| V3 (Track2) | `@autorest/<language>` | `3.x` |
### Generate More Idiomatic SDKs

Просмотреть файл

@ -63,3 +63,9 @@ stages:
image: azuresdk/autorest-java
dockerFolder: ./docker/java/ubuntu
readmePath: docker/java/readme.md
- template: ./templates/build-and-push-docker.yaml
parameters:
name: java
image: azuresdk/autorest-all
dockerFolder: ./docker/all/ubuntu
readmePath: docker/all/readme.md