Publish `Microsoft Authored` templates to azure samples browser

Azure / awesome-azd

An awesome list that curates content (articles, videos, tutorials and docs) and templates (ready to use) for the Azure Developer CLI (`azd`). Plus a hosted azd-templates Gallery to simplify search & discovery

https://aka.ms/awesome-azd

MIT License

177 stars 94 forks source link

Publish `Microsoft Authored` templates to azure samples browser #281

Closed rajeshkamal5050 closed 2 months ago

rajeshkamal5050 commented 10 months ago

Not all Microsoft authored templates are onboarded to the azure samples browser. The onboarding process https://review.learn.microsoft.com/en-us/help/contribute/samples/process/onboarding?branch=main

Please refer to the issue and changes @weikanglim did for onboarding the TODO templates and do the same for all Microsoft Authored templates.

cc @hemarina @gkulin @spboyer

v-xuto commented 10 months ago

@rajeshkamal5050 For publishing Microsoft-authored templates to Azure sample browser, we have created a PR, please review. If it's okay, we'll create PRs for the rest of templates.

https://github.com/Azure-Samples/function-javascript-ai-openai-chatgpt/pull/7

hemarina commented 10 months ago

@v-xuto This PR LGTM. Feel free to create PRs for the rest of template while we are waiting function-javascript-ai-openai-chatgpt owner to merge the PR.

v-xuto commented 10 months ago

@v-xuto This PR LGTM. Feel free to create PRs for the rest of template while we are waiting function-javascript-ai-openai-chatgpt owner to merge the PR.

@hemarina Got it. We will create PRs for the rest of the templates.

v-xuto commented 10 months ago

@hemarina We have created 11 PRs so far, please review.

v-xuto commented 10 months ago

@hemarina 12 new PRs were created today, please review.

v-xuto commented 10 months ago

@hemarina 8 new PRs were created today, please review.

hemarina commented 10 months ago

@v-xuto Thank you very much. I reviewed all opened PRs and pinged repro owner or engineers. They will review and merge the PRs as I don't have merge access to most repositories. It will be great if repro owner or engineers are pinged as well when creating new opened PRs.

For https://github.com/Azure-Samples/azure-django-postgres-flexible-aca/pull/85, we will need to open it in https://github.com/kjaymiller/cookiecutter-relecloud according to https://github.com/Azure-Samples/azure-django-postgres-flexible-aca/pull/85#issuecomment-1893956256.

v-xuto commented 10 months ago

@hemarina Thanks for your quick review. 5 new PRs were created today, and added the owner of repos. Please review. For https://github.com/Azure-Samples/azure-django-postgres-flexible-aca/pull/85, we will create PR in repo https://github.com/kjaymiller/cookiecutter-relecloud.

v-xuto commented 10 months ago

@hemarina 1 new PR was created today, please review.

https://github.com/kjaymiller/cookiecutter-relecloud/pull/324

So far, we have created all PRs for the required templates. 55 All Microsoft authored templates = 37 PRs + 14 have supported templates + 2 have added metadata templates + 2 no need templates

2 have added metadata templates: In the Readme, they have their own corresponding metadata, but they are not displayed in the azure samples browser. We don't know what causes this. Do you have any ideas? -> https://github.com/Azure-Samples/todo-nodejs-mongo-aks -> https://github.com/Azure-Samples/todo-python-mongo
2 no need templates： -> https://github.com/Azure-Samples/azd-starter-bicep -> https://github.com/Azure-Samples/azd-starter-terraform

hemarina commented 10 months ago

@v-xuto Thanks. IMO, filling onboarding form is needed according to onboarding checklist. I submitted todo-nodejs-mongo-aks and todo-python-mongo to the form. It will take sometime to show in azure samples browser. Could you track and submit the rest repros once PRs are merged?

v-xuto commented 10 months ago

@hemarina Got it. For the repos whose PRs have been merged, I've filled them in the onboarding form . Next, I will continue to track the remaining repos, whose PRs are open.

hemarina commented 10 months ago

Some repositories in the gallery are demos for event like Build and currently does not have maintainers. For example, Azure-Samples/openai-plugin-fastapi. The question is do we want to have these repos in the gallery. Considering it isn't being maintained and owned by anyone, I think we might want to remove it. @rajeshkamal5050 @gkulin in case for different thoughts.

hemarina commented 9 months ago

Have an offline chat with @v-xuto. We realized that some repos are not successfully published to learning page due to Invalid products found in https://github.com/MicrosoftDocs/samples. The next step is to update products slug or submit slug request for new ones based on Onboarding Samples to learn.microsoft.com/samples.

v-xuto commented 9 months ago

@hemarina To fix invalid slugs, we have created 13 PRs, please review.

v-xuto commented 9 months ago

@hemarina To fix invalid slugs, 2 new PRs were created today, please review.

v-xuto commented 9 months ago

@hemarina In Microsoft authored templates, there are two new repos. So, 2 PRs for adding metadata are ready, please review.

zedy-wj commented 7 months ago

@hemarina - We have filed one more PR to fix issue #760.

https://github.com/Azure-Samples/chat-with-your-data-solution-accelerator/pull/764

v-xuto commented 5 months ago

@hemarina 9 new PRs were created today, please review.

v-xuto commented 5 months ago

@hemarina 3 new PRs were created today, please review.

justinyoo commented 5 months ago

@rajeshkamal5050 I've got a question around this frontmatter metadata. Can this frontmatter be wrapped with ?

For example, here's the APICenter-Reference:

---
page_type: sample
languages:
- azdeveloper
- javascript
- csharp
- powershell
- bash
- html
- bicep
products:
- azure
- azure-api-center
- azure-api-management
- azure-app-service
- azure-event-grid
- azure-logic-apps
- static-web-apps
urlFragment: APICenter-Reference
name: API Center Reference
description: Let developer experiences how to use API Center (APIC) and seamless integration with API Management (APIM), as well as inner-loop development velocity increase.
---

Instead of doing that, I wonder if it's possible to put like:

<!--
---
page_type: sample
languages:
- azdeveloper
- javascript
- csharp
- powershell
- bash
- html
- bicep
products:
- azure
- azure-api-center
- azure-api-management
- azure-app-service
- azure-event-grid
- azure-logic-apps
- static-web-apps
urlFragment: APICenter-Reference
name: API Center Reference
description: Let developer experiences how to use API Center (APIC) and seamless integration with API Management (APIM), as well as inner-loop development velocity increase.
---
-->

By doing so, this frontmatter is not visible to the reader, but machine still can read it?

v-xuto commented 5 months ago

@hemarina About above comments, any ideas? Perhaps, can we create a new docs/README.md file in repos and add metadata to the README.md under docs, such as: https://github.com/azure-samples/azure-search-openai-javascript/tree/main/docs.

hemarina commented 5 months ago

@justinyoo According to metadata-structure-for-yaml-front-matter, I believe we needs to add a valid yaml front matter and commented version wouldn't work.

@v-xuto Yeah, adding metadata to subfolder's readme sounds good!

v-xuto commented 5 months ago

@hemarina 5 new PRs were created today, please review.