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

Publish Microsoft Authored templates to azure samples browser #281

Closed
rajeshkamal5050 opened this issue Jan 4, 2024 · 23 comments
Closed
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@rajeshkamal5050
Copy link
Contributor

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
Copy link
Member

v-xuto commented Jan 5, 2024

@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.

@rajeshkamal5050 rajeshkamal5050 added this to the January 2024 - 1.5.X milestone Jan 10, 2024
@hemarina
Copy link
Contributor

@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
Copy link
Member

v-xuto commented Jan 11, 2024

@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.

@hemarina
Copy link
Contributor

hemarina commented Jan 17, 2024

@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 Azure-Samples/azure-django-postgres-flexible-aca#85, we will need to open it in https://github.com/kjaymiller/cookiecutter-relecloud according to Azure-Samples/azure-django-postgres-flexible-aca#85 (comment).

@v-xuto
Copy link
Member

v-xuto commented Jan 19, 2024

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

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

@hemarina
Copy link
Contributor

hemarina commented Jan 19, 2024

@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
Copy link
Member

v-xuto commented Jan 22, 2024

@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
Copy link
Contributor

hemarina commented Jan 22, 2024

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
Copy link
Contributor

hemarina commented Jan 30, 2024

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
Copy link
Member

v-xuto commented Feb 4, 2024

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

@v-xuto
Copy link
Member

v-xuto commented Feb 5, 2024

@zedy-wj
Copy link
Member

zedy-wj commented Apr 28, 2024

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

@justinyoo
Copy link
Contributor

@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
Copy link
Member

v-xuto commented Jun 17, 2024

@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
Copy link
Contributor

@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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

5 participants