diff --git a/README.md b/README.md index f9d5b094cf6..a789c9eb1f6 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,7 @@ Add your extension to the index to make it available in these CLI commands: - Extension source code goes into the `src` directory. - You can place your source code in this repository by creating a PR. - Once CI is green and it has been approved, the PR can be merged. +- SDKs generated from [AutoRest](https://github.com/Azure/autorest) often do not pass CI static-checking. If they are vendored inside the extension, exclude them from static checking by placing them in the folder: `src//azext_*/vendored_sdks`. - Ensure that you include an appropriate owner for your extension in `.github/CODEOWNERS`. - Your extension artifact (i.e. `.whl`) will not live in this repository. You can publish your extension to PyPI or somewhere else such as Azure Storage. - If you want your extension to appear in the index.json, modify the index. diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000000..cb117c8425f --- /dev/null +++ b/docs/README.md @@ -0,0 +1,21 @@ +Azure CLI Extension Documention +======================= +Information +------------ + +Take a look at: [Azure CLI Extensions](https://github.com/Azure/azure-cli/tree/dev/doc/extensions) + +Doc Sections +------------ + +- [Authoring](https://github.com/Azure/azure-cli/blob/dev/doc/extensions/authoring.md) - How to author and develop an extension + +- [Command Guidelines](https://github.com/Azure/azure-cli/blob/dev/doc/command_guidelines.md) - Command Guidelines + +- [Publishing](https://github.com/Azure/azure-cli/blob/dev/doc/extensions/publishing.md) - How to publish an extension + +- [Summary Guidelines](https://github.com/Azure/azure-cli/blob/dev/doc/extensions/extension_summary_guidelines.md) - Summary guidelines for extensions to be published + +- [Extension Metadata](https://github.com/Azure/azure-cli/blob/dev/doc/extensions/metadata.md) - How to add additional extension metadata + +- [FAQ](https://github.com/Azure/azure-cli/blob/dev/doc/extensions/faq.md) - Commonly asked questions diff --git a/docs/extension_summary_guidelines.md b/docs/extension_summary_guidelines.md deleted file mode 100644 index d9d3cbf8637..00000000000 --- a/docs/extension_summary_guidelines.md +++ /dev/null @@ -1,39 +0,0 @@ -# Extension Summary Guidelines - -Extension summaries are required to follow these rules in order to be published -on the documentation site: - -1. Summaries must contain complete sentences. -2. Summaries must not be more than 3 sentences. Single sentences are preferred, 120-140 character max. -3. Summaries must use correct spelling and English grammar, including definite and indefinite articles for nouns ('the', 'a', or 'an') -4. Extension names are not proper nouns (i.e. should be 'alias extension', not 'Alias Extension') - - BAD: Azure CLI Alias Extension - IMPROVED: The Azure CLI alias extension. - -4. Summaries must provide a useful description. - - BAD: Azure IoT CLI Extension - IMPROVED: Additional IoT commands. - -5. Summaries should not include the following language: 'An extension', 'Azure CLI', 'command-line', or other language that refers to the CLI product or the object being installed as an extension. These are implicit: You are finding the extensions either via `az extension` or directly on the Azure CLI documentation site. - - BAD: Azure CLI Alias Extension - IMPROVED: The Azure CLI alias extension. - BEST: Support for command aliases. - - BAD: An Azure CLI Extension that copies images from region to region. - IMPROVED: Support for copying images between regions. - -6. Summaries must be as specific as possible. For example the term 'images' used in the examples for 5 is ambiguous. VM images? Container images? - -7. Summaries which included branded product names should use the correct branding terminology and capitalization. - - BAD: Microsoft Azure Command-Line Tools Extended Batch Command Module - IMPROVED: Additional Azure Batch commands. - -8. Provide an example (or examples) of the types of commands added or modified. - - BAD: Azure IoT CLI Extension - IMPROVED: Additional IoT commands. - BEST: Additional commands for working with IoT Hub, Edge, and device provisioning.