Add readme validation step

[diondrapeck]

Description

Add workflow PR-check step to confirm that each sample folder has a README file matching our template.

Checklist

• I have read the contribution guidelines
• I have coordinated with the docs team ([email protected]) 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 file, pointing to the author or the author's team.

[sdgilley]

Docs approval. None of these changes will break the docs build.

[JasonWHowell]

@diondrapeck @kdestin this PR may have broken the ML docs that refer to these notebooks. Azure-docs-pr is erroring for 2 hours because of it, so all azure docs are getting the error. Can you take a look? https://github.com/MicrosoftDocs/azure-docs-pr/pull/263152#issuecomment-1890077419

[diondrapeck]

Hi Jason, Due to the late Friday timing, I can just revert the PR for now. I had Sheri review and approve these changes ahead of time to try to avoid this happening. I'll follow up next week to see what's missing in our process to prevent these issues. Best, Diondra

…

________________________________ From: Jason Howell ***@***.***> Sent: Friday, January 12, 2024 2:54 PM To: Azure/azureml-examples ***@***.***> Cc: Diondra Peck ***@***.***>; Mention ***@***.***> Subject: Re: [Azure/azureml-examples] Add readme validation step (PR #2748) @diondrapeck<https://github.com/diondrapeck> @kdestin<https://github.com/kdestin> this PR may have broken the ML docs that refer to these notebooks. Azure-docs-pr is erroring for 2 hours because of it, so all azure docs are down. Can you take a look? MicrosoftDocs/azure-docs-pr#263152 (comment)<MicrosoftDocs/azure-docs-pr#263152 (comment)> — Reply to this email directly, view it on GitHub<#2748 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AD46GG6UNUYKG53TC2FGJD3YOG5KBAVCNFSM6AAAAAA6HWMFDKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQOJQGA4DMOBVGM>. You are receiving this because you were mentioned.Message ID: ***@***.***>

[JasonWHowell]

@diondrapeck The failures are isolation to two notebooks I think
/sdk/python/featurestore_sample/notebooks/sdk_only/3. Enable recurrent materialization and run batch inference.ipynb
/sdk/python/featurestore_sample/notebooks/sdk_only/1. Develop a feature set and register with managed feature store.ipynb

[diondrapeck]

I've reverted all the changes for now. I'll look into it more next week. I unfortunately don't have much time today to dig deeper and I don't want to broken docs linger into the weekend. Thanks for alerting us! Best, Diondra

…

________________________________ From: Jason Howell ***@***.***> Sent: Friday, January 12, 2024 3:13 PM To: Azure/azureml-examples ***@***.***> Cc: Diondra Peck ***@***.***>; Mention ***@***.***> Subject: Re: [Azure/azureml-examples] Add readme validation step (PR #2748) @diondrapeck<https://github.com/diondrapeck> The failures are isolation to two notebooks I think /sdk/python/featurestore_sample/notebooks/sdk_only/3. Enable recurrent materialization and run batch inference.ipynb /sdk/python/featurestore_sample/notebooks/sdk_only/1. Develop a feature set and register with managed feature store.ipynb — Reply to this email directly, view it on GitHub<#2748 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AD46GG4KLD6L3HSMWXZ5L4LYOG7SLAVCNFSM6AAAAAA6HWMFDKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQOJQGEZDSNBUGE>. You are receiving this because you were mentioned.Message ID: ***@***.***>

[sdgilley]

I see the problem. None of the changes made to cells in these notebooks are breaking changes, which is why I approved.

BUT the notebooks themselves have some syntax errors in the json, both display as Invalid notebooks:

• 1. Develop a feature set and register with managed feature store.ipynb
• 3. Enable recurrent materialization and run batch inference.ipynb

Isn't there a check to see if the modified notebooks will run? I don't see that in this PR, was it skipped because of so many changes? If we can't run them, is there at least a way to make sure that all modified notebooks are valid notebooks prior to a merge?