From 349ca09d5d3e02c865970ac2d497f4797dbcda83 Mon Sep 17 00:00:00 2001 From: Diondra Peck Date: Mon, 28 Aug 2023 15:54:58 -0700 Subject: [PATCH 1/9] Update CONTRIBUTING.md --- CONTRIBUTING.md | 21 +++++++-------------- 1 file changed, 7 insertions(+), 14 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c0e37466a7..964581db0a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,12 +20,12 @@ contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additio ## Goals -- source for all code snippets in documentation +This repository contains notebooks and sample code that demonstrate how to develop and manage ML workflows using Azure Machine Learning v2 SDK and CLI. ## Non-goals -- serve as documentation (see https://docs.microsoft.com/azure/machine-learning) -- serve as scenario-specific project templates (coming soon!) +- This repository is not meant to serve as reference documentation. Reference documentation for the azure-ai-ml package can be found [here](https://learn.microsoft.com/en-us/python/api/azure-ai-ml/?view=azure-python). +- This repository is not meant to serve as conceptual overview or comprehensive getting started documents. All long-form textual documentation can be found [here](https://learn.microsoft.com/en-us/python/api/azure-ai-ml/?view=azure-python). ## Issues @@ -92,14 +92,7 @@ description: Example description. **Edit the description** and update the languages as needed. -### CLI 2.0 - -[CLI contributing guide.](cli/CONTRIBUTING.md) - -### Python SDK - -[Python SDK contributing guide.](python-sdk/CONTRIBUTING.md) - -### Notebooks - -[Notebooks contributing guide.](notebooks/CONTRIBUTING.md) +### Other resources +* [CLI contributing guide.](cli/CONTRIBUTING.md) +* [Python SDK contributing guide.](python-sdk/CONTRIBUTING.md) +* [Notebooks contributing guide.](notebooks/CONTRIBUTING.md) From 93617563557ac2fd290ca4dc371ff99050bc0cb2 Mon Sep 17 00:00:00 2001 From: Diondra Peck Date: Tue, 29 Aug 2023 11:05:37 -0700 Subject: [PATCH 2/9] Add CODEOWNERS check to pull request template --- .github/PULL_REQUEST_TEMPLATE.md | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 3fb98af839..85b97cb2b9 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -7,3 +7,4 @@ - [ ] I have read the [contribution guidelines](https://github.com/Azure/azureml-examples/blob/main/CONTRIBUTING.md) - [ ] I have coordinated with the docs team (mldocs@microsoft.com) if this PR deletes files or changes any file names or file extensions. - [ ] Pull request includes test coverage for the included changes. +- [ ] This notebook or file is added to the [CODEOWNERS](https://github.com/Azure/azureml-examples/blob/main/.github/CODEOWNERS) file, pointing to the author or the author's team. From ae65f9b00b4cfc09aa680febfc933e6a007cebf0 Mon Sep 17 00:00:00 2001 From: Diondra Peck Date: Tue, 29 Aug 2023 12:50:44 -0700 Subject: [PATCH 3/9] Update CONTRIBUTING.md Goals section --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 964581db0a..f9f3ed6de3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,7 +20,7 @@ contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additio ## Goals -This repository contains notebooks and sample code that demonstrate how to develop and manage ML workflows using Azure Machine Learning v2 SDK and CLI. +This repository contains notebooks and sample code that demonstrate how to develop and manage ML workflows using Azure Machine Learning v2 SDK and CLI. Use the samples in this repository to try out AzureML SDK and CLI examples on your local machine. ## Non-goals From 4b74666a118f268e4b975d5d85a959a7caabd472 Mon Sep 17 00:00:00 2001 From: Diondra Peck Date: Tue, 29 Aug 2023 12:55:55 -0700 Subject: [PATCH 4/9] Update CONTRIBUTING.md Goals section --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f9f3ed6de3..0c2e8e609a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,7 +20,7 @@ contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additio ## Goals -This repository contains notebooks and sample code that demonstrate how to develop and manage ML workflows using Azure Machine Learning v2 SDK and CLI. Use the samples in this repository to try out AzureML SDK and CLI examples on your local machine. +This repository contains notebooks and sample code that demonstrate how to develop and manage ML workflows using Azure Machine Learning v2 SDK and CLI. Use the samples in this repository to try out AzureML SDK and CLI scenarios from your local machine. ## Non-goals From 67950d201a3b70f04e12daf73621d1e0619e13b1 Mon Sep 17 00:00:00 2001 From: Diondra Peck Date: Tue, 29 Aug 2023 14:26:50 -0700 Subject: [PATCH 5/9] Fix typos --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- CONTRIBUTING.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 85b97cb2b9..0c8ff6a495 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -7,4 +7,4 @@ - [ ] I have read the [contribution guidelines](https://github.com/Azure/azureml-examples/blob/main/CONTRIBUTING.md) - [ ] I have coordinated with the docs team (mldocs@microsoft.com) if this PR deletes files or changes any file names or file extensions. - [ ] Pull request includes test coverage for the included changes. -- [ ] This notebook or file is added to the [CODEOWNERS](https://github.com/Azure/azureml-examples/blob/main/.github/CODEOWNERS) file, pointing to the author or the author's team. +- [ ] This notebook or file is added to the [CODEOWNERS](https://github.com/Azure/azureml-examples/blob/main/.github/CODEOWNERS) file, pointing to the author or the author's team. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0c2e8e609a..b2799779e0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -25,7 +25,7 @@ This repository contains notebooks and sample code that demonstrate how to devel ## Non-goals - This repository is not meant to serve as reference documentation. Reference documentation for the azure-ai-ml package can be found [here](https://learn.microsoft.com/en-us/python/api/azure-ai-ml/?view=azure-python). -- This repository is not meant to serve as conceptual overview or comprehensive getting started documents. All long-form textual documentation can be found [here](https://learn.microsoft.com/en-us/python/api/azure-ai-ml/?view=azure-python). +- This repository is not meant to serve as conceptual overview or comprehensive getting started documents. All long-form textual documentation can be found [here](https://learn.microsoft.com/en-us/azure/machine-learning/?view=azureml-api-2). ## Issues From 06dfeab7e0f415060e590fc4c14374227d482510 Mon Sep 17 00:00:00 2001 From: Diondra Peck Date: Mon, 11 Sep 2023 10:33:20 -0700 Subject: [PATCH 6/9] Update CONTRIBUTING.md Non-goals section --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b2799779e0..61dfe692de 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,8 +24,8 @@ This repository contains notebooks and sample code that demonstrate how to devel ## Non-goals -- This repository is not meant to serve as reference documentation. Reference documentation for the azure-ai-ml package can be found [here](https://learn.microsoft.com/en-us/python/api/azure-ai-ml/?view=azure-python). -- This repository is not meant to serve as conceptual overview or comprehensive getting started documents. All long-form textual documentation can be found [here](https://learn.microsoft.com/en-us/azure/machine-learning/?view=azureml-api-2). +- This repository is not meant to serve as reference documentation. Small code examples that are just comprehensive enough to show how an object or function works are categorized as reference documentation and should be placed in the object or function docstring in the [azure-ai-ml repository](https://learn.microsoft.com/en-us/python/api/azure-ai-ml/?view=azure-python). +- This repository is not meant to serve as conceptual overview or comprehensive getting started documents. Long-form textual documentation, especially ones with minimal or no code should be added in the [azure-docs repository](https://github.com/MicrosoftDocs/azure-docs). ## Issues From 47adc659bf726629ed32f1fefba85a5a36dac14e Mon Sep 17 00:00:00 2001 From: Diondra Peck Date: Tue, 12 Sep 2023 15:39:20 -0700 Subject: [PATCH 7/9] Update wording for Non-goals --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 61dfe692de..4d9f35069a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -25,7 +25,7 @@ This repository contains notebooks and sample code that demonstrate how to devel ## Non-goals - This repository is not meant to serve as reference documentation. Small code examples that are just comprehensive enough to show how an object or function works are categorized as reference documentation and should be placed in the object or function docstring in the [azure-ai-ml repository](https://learn.microsoft.com/en-us/python/api/azure-ai-ml/?view=azure-python). -- This repository is not meant to serve as conceptual overview or comprehensive getting started documents. Long-form textual documentation, especially ones with minimal or no code should be added in the [azure-docs repository](https://github.com/MicrosoftDocs/azure-docs). +- This repository is not the place for long-form textual documentation. Documentation resources containing minimal or no code should be added in the [azure-docs repository](https://github.com/MicrosoftDocs/azure-docs). ## Issues From 14ff497f2f67d68f9748070e9fe19b5eb050b386 Mon Sep 17 00:00:00 2001 From: Diondra Peck Date: Tue, 12 Sep 2023 16:13:51 -0700 Subject: [PATCH 8/9] Update CONTRIBUTING.md additional resources --- CONTRIBUTING.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4d9f35069a..773f1993e5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -71,7 +71,7 @@ This will also generate a GitHub Actions workflow file for any new examples in t ### Discoverability -Examples in this repository can be index in the [Microsoft code samples browser](https://docs.microsoft.com/samples), enabling organic discoverability. To accomplish this: +Examples in this repository can be indexed in the [Microsoft code samples browser](https://docs.microsoft.com/samples), enabling organic discoverability. To accomplish this: - add an excellent `README.md` file in the example directory - add required YAML frontmatter at the top of the `README.md` @@ -93,6 +93,4 @@ description: Example description. **Edit the description** and update the languages as needed. ### Other resources -* [CLI contributing guide.](cli/CONTRIBUTING.md) -* [Python SDK contributing guide.](python-sdk/CONTRIBUTING.md) -* [Notebooks contributing guide.](notebooks/CONTRIBUTING.md) +* [CLI contributing guide.](cli/CONTRIBUTING.md) \ No newline at end of file From 2886c5afe46f5e75a2ce8497bef8a321dbdd9acc Mon Sep 17 00:00:00 2001 From: Diondra <16376603+diondrapeck@users.noreply.github.com> Date: Wed, 13 Sep 2023 10:23:54 -0700 Subject: [PATCH 9/9] Update CONTRIBUTING.md links --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 773f1993e5..d14591b2fd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,7 +24,7 @@ This repository contains notebooks and sample code that demonstrate how to devel ## Non-goals -- This repository is not meant to serve as reference documentation. Small code examples that are just comprehensive enough to show how an object or function works are categorized as reference documentation and should be placed in the object or function docstring in the [azure-ai-ml repository](https://learn.microsoft.com/en-us/python/api/azure-ai-ml/?view=azure-python). +- This repository is not meant to serve as reference documentation. Small code examples that are just comprehensive enough to show how an object or function works are categorized as reference documentation and should be placed in the object or function docstring in the [azure-ai-ml folder of the azure-sdk-for-python repository](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/ml/azure-ai-ml) following [these guidelines](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/ml/azure-ai-ml/documentation_guidelines.md). - This repository is not the place for long-form textual documentation. Documentation resources containing minimal or no code should be added in the [azure-docs repository](https://github.com/MicrosoftDocs/azure-docs). ## Issues @@ -93,4 +93,4 @@ description: Example description. **Edit the description** and update the languages as needed. ### Other resources -* [CLI contributing guide.](cli/CONTRIBUTING.md) \ No newline at end of file +* [CLI contributing guide.](cli/CONTRIBUTING.md)