Skip to content
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.

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

Replaced relative link with absolute links and remove locale #13846

Merged
merged 5 commits into from
Sep 18, 2020
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ Mypy install and run.

### More Reading

We maintain an [additional document](doc/eng_sys_checks.md) that has a ton of detail as to what is actually _happening_ in these executions.
We maintain an [additional document](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/eng_sys_checks.md) that has a ton of detail as to what is actually _happening_ in these executions.

### Dev Feed
Daily dev build version of Azure sdk packages for python are available and are uploaded to Azure devops feed daily. We have also created a tox environment to test a package against dev built version of dependent packages. Below is the link to Azure devops feed.
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Each service might have a number of libraries available from each of the followi

### Client: New Releases

New wave of packages that we are announcing as **GA** and several that are currently releasing in **preview**. These libraries allow you to use and consume existing resources and interact with them, for example: upload a blob. These libraries share a number of core functionalities such as: retries, logging, transport protocols, authentication protocols, etc. that can be found in the [azure-core](./sdk/core/azure-core) library. You can learn more about these libraries by reading guidelines that they follow [here](https://azure.github.io/azure-sdk/python_introduction.html).
New wave of packages that we are announcing as **GA** and several that are currently releasing in **preview**. These libraries allow you to use and consume existing resources and interact with them, for example: upload a blob. These libraries share a number of core functionalities such as: retries, logging, transport protocols, authentication protocols, etc. that can be found in the [azure-core](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/core/azure-core) library. You can learn more about these libraries by reading guidelines that they follow [here](https://azure.github.io/azure-sdk/python_introduction.html).

You can find the [most up to date list of all of the new packages on our page](https://azure.github.io/azure-sdk/releases/latest/index.html#python-packages)

Expand Down Expand Up @@ -60,7 +60,7 @@ Security issues and bugs should be reported privately, via email, to the Microso

## Contributing

For details on contributing to this repository, see the [contributing guide](CONTRIBUTING.md).
For details on contributing to this repository, see the [contributing guide](https://github.com/Azure/azure-sdk-for-python/blob/master/CONTRIBUTING.md).

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit
https://cla.microsoft.com.
Expand Down
6 changes: 3 additions & 3 deletions doc/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
This folder contains some documentations for this repository:

The folder structure is the following
- [sphinx](./sphinx) : contains the documentation source code for https://azure.github.io/azure-sdk-for-python/
- [dev](./dev) : contains advanced documentation for _developers_ of SDK (not _consumers_ of SDK)
- [sphinx](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/sphinx) : contains the documentation source code for https://azure.github.io/azure-sdk-for-python/
- [dev](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev) : contains advanced documentation for _developers_ of SDK (not _consumers_ of SDK)

The file [eng_sys_checks](eng_sys_checks.md) is a read up as to what a standard `ci.yml` will actually execute.
The file [eng_sys_checks](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/eng_sys_checks.md) is a read up as to what a standard `ci.yml` will actually execute.
8 changes: 4 additions & 4 deletions doc/dev/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
This folder contains documentation for developers of SDK: internal teams at Microsoft, or advanced contributors.

Overview of the documents:
- [dev setup](./dev_setup.md) : How to create a development environment for this repo
- [release](./release.md) : How to release a package when ready
- [packaging.md](./packaging.md) : How to organize packaging information for packages under `azure`
- [dev setup](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/dev_setup.md) : How to create a development environment for this repo
- [release](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/release.md) : How to release a package when ready
- [packaging.md](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/packaging.md) : How to organize packaging information for packages under `azure`

The [mgmt](./mgmt) folder contains information specific to management packages (i.e. packages prefixed by `azure-mgmt`)
The [mgmt](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/mgmt) folder contains information specific to management packages (i.e. packages prefixed by `azure-mgmt`)
10 changes: 5 additions & 5 deletions doc/dev/mgmt/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

The documentation in that folder is intended for developers at Microsoft, or for advanced contributors, in the ARM (Azure Resource Management) world.

The [cheat sheet](./cheatsheet.md) page contains a quick reminder of the basic commands if you are already familiar with this repo.
The [cheat sheet](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/mgmt/cheatsheet.md) page contains a quick reminder of the basic commands if you are already familiar with this repo.

In order of workflow:
- [swagger_conf.md](./swagger_conf.md) : Describe how to configure the different Readme on https://github.com/Azure/azure-rest-api-specs for Python
- [tests.md](./tests.md) : How to test management SDK (recordings, etc.)
- [mgmt_release.md](./mgmt_release.md) : How to finish preapring the package, changelog, version, etc.
- [swagger_conf.md](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/mgmt/swagger_conf.md) : Describe how to configure the different Readme on https://github.com/Azure/azure-rest-api-specs for Python
- [tests.md](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/mgmt/tests.md) : How to test management SDK (recordings, etc.)
- [mgmt_release.md](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/mgmt/mgmt_release.md) : How to finish preapring the package, changelog, version, etc.

More implementations / advanced documents:
- [changelog_impl.md](./changelog_impl.md) : Technical details about the change log tool implementation
- [changelog_impl.md](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/mgmt/changelog_impl.md) : Technical details about the change log tool implementation

4 changes: 2 additions & 2 deletions doc/dev/mgmt/generation.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Generation of SDK

Assuming your Swagger are associated with correct Readmes (otherwise see previous chapter [Swagger conf](./swagger_conf.md)), this page explains how to generate your packages.
Assuming your Swagger are associated with correct Readmes (otherwise see previous chapter [Swagger conf](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/mgmt/swagger_conf.md)), this page explains how to generate your packages.

IMPORTANT NOTE: All the commands prefixed by `python` in this page assumes you have loaded the [dev_setup](../dev_setup.md) in your currently loaded virtual environment.
IMPORTANT NOTE: All the commands prefixed by `python` in this page assumes you have loaded the [dev_setup](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/dev_setup.md) in your currently loaded virtual environment.

## Building the code

Expand Down
4 changes: 2 additions & 2 deletions doc/dev/mgmt/mgmt_release.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Once Swagger PR is merged, SDK automation will create pull request to Azure SDK

Once you have a PR that contains accurate with correct tests (or no tests at all, but CI is green), this page explains how to prepare for a release.

IMPORTANT NOTE: All the commands in this page assumes you have loaded the [dev_setup](../dev_setup.md) in your currently loaded virtual environment.
IMPORTANT NOTE: All the commands in this page assumes you have loaded the [dev_setup](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/dev_setup.md) in your currently loaded virtual environment.

## Manual generation

Expand Down Expand Up @@ -158,4 +158,4 @@ Python SDK _strictly_ follows [semver](https://semver.org/). A few notes:
- Next stable breaking is 3.0.0
- Next preview feature is 2.2.0rc1
- Next stable feature is 2.2.0
- Next patch is 2.1.1
- Next patch is 2.1.1
4 changes: 2 additions & 2 deletions doc/dev/mgmt/multiapi.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Network interfaces operations are defines in a [network interface file](https://

**Python multi-api packaging is based on the assumptions that it's true.** If it's not, it's usually ok but requires a little more subtle packaging (see final section here)

Being that a given Swagger defines only *one* fixed API version, doing multi-api version in one package implies shipping several Swagger files into one package. This is archived by the `batch` directive of Autorest. More details on how to write Readme for Swagger in the specific page for it [swagger_conf.md](./swagger_conf.md).
Being that a given Swagger defines only *one* fixed API version, doing multi-api version in one package implies shipping several Swagger files into one package. This is archived by the `batch` directive of Autorest. More details on how to write Readme for Swagger in the specific page for it [swagger_conf.md](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/mgmt/swagger_conf.md).

Python SDK team is responsible to design the correct set of tags to set for the `batch` node. Each line of the batch directive should contains only *one* api version to match the folder name used. this might require adding new tags in the readme.md that are specific to only one API version. These tags are usually suffixed by "-only" ([example with compute](https://github.com/Azure/azure-rest-api-specs/tree/master/specification/compute/resource-manager#tag-package-2019-03-01-only))

Expand Down Expand Up @@ -119,4 +119,4 @@ If this is not the same API version, then we need to bend the rules a little: we

Current implementation assumes operation group are unique, and as discussed it's not always the case. Also, this limitation has impact on intellisense right now. Example, if a user types `compute_client.virtual_machines.` and hit the intellisense shortcut, users won't see any suggestions. It's because the `virtual_machines` property is dynamic and can change depending of dynamic configuration.

To improve intellisense and allow operation level profile, the concept would be to make the [operation mixin multi-api concept](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/network/azure-mgmt-network/azure/mgmt/network/_operations_mixin.py) applicable to operation groups as well. I estimate this work to a week of dev-ish.
To improve intellisense and allow operation level profile, the concept would be to make the [operation mixin multi-api concept](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/network/azure-mgmt-network/azure/mgmt/network/_operations_mixin.py) applicable to operation groups as well. I estimate this work to a week of dev-ish.
2 changes: 1 addition & 1 deletion doc/dev/mgmt/swagger/single_api/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,4 +66,4 @@ swagger-to-sdk:

## Python

See configuration in [readme.python.md](./readme.python.md)
See configuration in [readme.python.md](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/mgmt/swagger/single_api/readme.python.md)
2 changes: 1 addition & 1 deletion doc/dev/mgmt/swagger_conf.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Nowadays, swagger files are actually not the input for Autorest, the input is _r
autorest readme.md --python
```

In practical terms, we want to control the version of Autorest used, the output folder, etc. but this article will focus on Swagger and Readme. For more details about generation, see the [generation page](./generation.md).
In practical terms, we want to control the version of Autorest used, the output folder, etc. but this article will focus on Swagger and Readme. For more details about generation, see the [generation page](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/mgmt/generation.md).

## Writing the readme

Expand Down
2 changes: 1 addition & 1 deletion doc/dev/mgmt/tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
- [Running tests in live mode](#running-tests-in-live-mode)
- [Using the Azure Python SDK test framework](#using-the-azure-python-sdk-test-framework)

IMPORTANT NOTE: All the commands in this page assumes you have loaded the [dev_setup](../dev_setup.md) in your currently loaded virtual environment.
IMPORTANT NOTE: All the commands in this page assumes you have loaded the [dev_setup](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/dev_setup.md) in your currently loaded virtual environment.

# Overview

Expand Down
4 changes: 2 additions & 2 deletions doc/eng_sys_checks.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

There are various tests currently enabled in Azure pipeline for Python SDK and some of them are enabled only for nightly CI checks. We also run some static analysis tool to verify code completeness, security and lint check.

Check the [contributing guide](../CONTRIBUTING.md#building-and-testing) for an intro to `tox`.
Check the [contributing guide](https://github.com/Azure/azure-sdk-for-python/blob/master/CONTRIBUTING.md#building-and-testing) for an intro to `tox`.

As a contributor, you will see the build jobs run in two modes: `Nightly Scheduled` and `Pull Request`.

Expand Down Expand Up @@ -45,7 +45,7 @@ Analyze job in both nightly CI and pull request validation pipeline runs a set o

#### Change log verification

Change log verification is added to ensure package has valid change log for current version. Guidelines to properly maintain the change log is documented [here]()
Change log verification is added to ensure package has valid change log for current version. Guidelines to properly maintain the change log is documented [here](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/)

## PR Validation Checks
Each pull request runs various tests using `pytest` in addition to all the tests mentioned above in analyze check. Pull request validation performs 3 different types of test: `whl, sdist and depends`. Following section explains the purpose of each of these tests and how to execute them locally. All pull requests are validated on multiple python versions across different platforms and below is the test matrix for pull request.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,6 @@ what you can do with the Azure Anomaly Detector client library.
[azure_anomaly_detector_account]: https://ms.portal.azure.com/#create/Microsoft.CognitiveServicesAnomalyDetector
[python-fr-ref-docs]: https://azuresdkdocs.blob.core.windows.net/$web/python/azure-cognitiveservices-anomalydetector/0.3.0/index.html

[sample_detect_entire_series_anomaly]: ./sample_detect_entire_series_anomaly.py
[sample_detect_last_point_anomaly]: ./sample_detect_last_point_anomaly.py
[sample_detect_change_point]: ./sample_detect_change_point.py
[sample_detect_entire_series_anomaly]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/anomalydetector/azure-ai-anomalydetector/samples/sample_detect_entire_series_anomaly.py
[sample_detect_last_point_anomaly]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/anomalydetector/azure-ai-anomalydetector/samples/sample_detect_last_point_anomaly.py
[sample_detect_change_point]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/anomalydetector/azure-ai-anomalydetector/samples/sample_detect_change_point.py
2 changes: 1 addition & 1 deletion sdk/appconfiguration/azure-appconfiguration/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Modern programs, especially programs running in a cloud, generally have many com

Use the client library for App Configuration to create and manage application configuration settings.

[Source code]() | [Package (Pypi)][package] | [API reference documentation]() | [Product documentation][appconfig_docs]
[Source code](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/appconfiguration/azure-appconfiguration) | [Package (Pypi)][package] | [API reference documentation](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/appconfiguration/azure-appconfiguration) | [Product documentation][appconfig_docs]

## Getting started

Expand Down
2 changes: 1 addition & 1 deletion sdk/core/azure-core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ These libraries follow the [Azure SDK Design Guidelines for Python](https://azur

If you are a client library developer, please reference [client library developer reference](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md) for more information.

[Source code]() | [Package (Pypi)][package] | [API reference documentation]()
[Source code](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/core/azure-core/) | [Package (Pypi)][package] | [API reference documentation](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/core/azure-core/)

## Getting started

Expand Down
2 changes: 1 addition & 1 deletion sdk/core/azure-mgmt-core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Azure management core library defines extensions to Azure Core that are specific

As an end user, you don't need to manually install azure-mgmt-core because it will be installed automatically when you install other SDKs.

[Source code]() | [Package (Pypi)][package] | [API reference documentation]()
[Source code](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/core/azure-mgmt-core/) | [Package (Pypi)][package] | [API reference documentation](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/core/azure-mgmt-core/)


## Contributing
Expand Down
6 changes: 3 additions & 3 deletions sdk/cosmos/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Use the Azure Cosmos DB SQL API SDKs for application development and database ma

## Contents of this folder

### [azure-cosmos](./azure-cosmos)
### [azure-cosmos](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/cosmos/azure-cosmos)

This is the Azure Cosmos DB SQL API SDK for Python to manage databases and the JSON documents they contain in this NoSQL database service. High level capabilities are:

Expand All @@ -17,7 +17,7 @@ This is the Azure Cosmos DB SQL API SDK for Python to manage databases and the J

Use this package if you are creating an application or exploring data.

### [azure-mgmt-cosmosdb](./azure-mgmt-cosmosdb)
### [azure-mgmt-cosmosdb](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/cosmos/azure-mgmt-cosmosdb)

This is the Microsoft Azure Cosmos DB Management Client Library. High level capabilities are:

Expand All @@ -34,7 +34,7 @@ This is the Microsoft Azure Cosmos DB Management Client Library. High level capa

Use this package if you are creating an account level management application.

### [azure-mgmt-documentdb](./azure-mgmt-documentdb)
### [azure-mgmt-documentdb](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/cosmos/azure-mgmt-documentdb)

Legacy DocumentDB SDK.

Expand Down
Loading