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

New article - Create Azure functions for SharePoint webhooks using an azd template #10118

Merged
merged 23 commits into from
Mar 5, 2025

Conversation

Yvand
Copy link
Contributor

@Yvand Yvand commented Feb 17, 2025

Category

  • Content fix
  • New article

What's in this Pull Request?

Proposing a new article to create Azure functions for SharePoint webhooks using an azd template

Copy link
Contributor

Learn Build status updates of commit 83c4281:

💡 Validation status: suggestions

File Status Preview URL Details
docs/apis/webhooks/sharepoint-webhooks-using-azd-template.md 💡Suggestion View Details

docs/apis/webhooks/sharepoint-webhooks-using-azd-template.md

  • Line 10, Column 210: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://learn.microsoft.com/sharepoint/dev/apis/webhooks/overview-sharepoint-webhooks' will be broken in isolated environments. Replace with a relative link.
  • Line 15, Column 3: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://learn.microsoft.com/azure/azure-functions/functions-run-local?pivots=programming-language-typescript#install-the-azure-functions-core-tools' will be broken in isolated environments. Replace with a relative link.
  • Line 16, Column 3: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://learn.microsoft.com/azure/developer/azure-developer-cli/install-azd' will be broken in isolated environments. Replace with a relative link.
  • Line 23, Column 14: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://learn.microsoft.com/azure/role-based-access-control/built-in-roles/privileged#contributor' will be broken in isolated environments. Replace with a relative link.
  • Line 24, Column 14: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://learn.microsoft.com/azure/role-based-access-control/built-in-roles/privileged#role-based-access-control-administrator' will be broken in isolated environments. Replace with a relative link.
  • Line 38, Column 11: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://learn.microsoft.com/azure/developer/azure-developer-cli/manage-environment-variables' will be broken in isolated environments. Replace with a relative link.
  • Line 59, Column 63: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://learn.microsoft.com/graph/permissions-reference#approleassignmentreadwriteall' will be broken in isolated environments. Replace with a relative link.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

Copy link
Contributor

Learn Build status updates of commit e69a919:

⚠️ Validation status: warnings

File Status Preview URL Details
docs/apis/webhooks/sharepoint-webhooks-using-azd-template.md ⚠️Warning View Details

docs/apis/webhooks/sharepoint-webhooks-using-azd-template.md

  • Line 10, Column 210: [Warning: file-not-found - See documentation] Invalid file link: 'overview-sharepoint-webhooks'.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

Copy link
Contributor

Learn Build status updates of commit ee30ad5:

✅ Validation status: passed

File Status Preview URL Details
docs/apis/webhooks/sharepoint-webhooks-using-azd-template.md ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:

@andrewconnell andrewconnell added the pr:in-review Actively reviewing pull request label Feb 19, 2025
@andrewconnell andrewconnell self-assigned this Feb 19, 2025
- typos
- links shouldn't point to "this", rather be descriptive
- markdown fixes
  - paragraphs should be seperated by newlines
  - bullets should be `-`, not `+`
@andrewconnell
Copy link
Collaborator

@VesaJuvonen new doc submission... can you review & let me know if this is ok to merge?

@Yvand where would you suggest this go in the TOC?

@andrewconnell andrewconnell added Needs: Attention 👋 Original poster responded to request for feedback, awaiting attention from Microsoft / community. pr:do-not-merge Pull request not ready to be merged and removed pr:in-review Actively reviewing pull request labels Feb 19, 2025
Copy link
Contributor

Learn Build status updates of commit d73ebdc:

✅ Validation status: passed

File Status Preview URL Details
docs/apis/webhooks/sharepoint-webhooks-using-azd-template.md ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:

@Yvand
Copy link
Contributor Author

Yvand commented Feb 19, 2025

@andrewconnell thank you for your review.
I am not sure to understand your question about the TOC, but this article provides an alternative to https://learn.microsoft.com/en-us/sharepoint/dev/apis/webhooks/sharepoint-webhooks-using-azure-functions (it achieves exactly the same goal in a different way)

@VesaJuvonen
Copy link
Contributor

Looks like a great new doc with good content which we want to get updated. @andrewconnell will clean up things a bit to align with the learn publishing practices and we'll get it then merged and published after that's completed.

@VesaJuvonen VesaJuvonen removed their assignment Feb 19, 2025
Copy link
Contributor

@VesaJuvonen VesaJuvonen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good to go after addressing the formatting changes.

Copy link
Contributor

Learn Build status updates of commit 8a7effc:

✅ Validation status: passed

File Status Preview URL Details
docs/apis/webhooks/sharepoint-webhooks-using-azd-template.md ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:

Copy link
Contributor

Learn Build status updates of commit 1dc96bb:

✅ Validation status: passed

File Status Preview URL Details
docs/apis/webhooks/sharepoint-webhooks-using-azd-template.md ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:

@andrewconnell
Copy link
Collaborator

@Yvand I didn't intend to send single reviews... my mistake... still working on the doc today and will send the rest in batch. Thanks for taking care of those others promptly though

Copy link
Collaborator

@andrewconnell andrewconnell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Throughout the doc, inline code is used to format incorrectly. This should only be used for exactly that: inline code.

Use bold for file names, commands in the console,

@andrewconnell andrewconnell added Needs: Author Feedback Awaiting response from the original poster of the issue. Marked as stale if no activity for 7 days. pr:do-not-merge Pull request not ready to be merged and removed pr:in-review Actively reviewing pull request labels Feb 26, 2025
Copy link
Contributor

Learn Build status updates of commit 9ed7854:

✅ Validation status: passed

File Status Preview URL Details
docs/apis/webhooks/sharepoint-webhooks-using-azd-template.md ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:

@Yvand
Copy link
Contributor Author

Yvand commented Feb 27, 2025

@andrewconnell thank you for your time to review it.
I hope I correctly addressed all your points, my only doubt is about DefaultAzureCredential:
Not sure if it should be DefaultAzureCredential or DefaultAzureCredential, I kept DefaultAzureCredential, but I will change it if needed.

All the following are inline with MSDOCS rules:

- change note about tutorial to NOTE type
- use "select" instead of "click" for accessibility
- bold whole link, not the text inside the `[]`
- copy edits rec'd by Acrolinx
Copy link
Contributor

Learn Build status updates of commit a11a23c:

✅ Validation status: passed

File Status Preview URL Details
docs/apis/webhooks/sharepoint-webhooks-using-azd-template.md ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:

Copy link
Collaborator

@andrewconnell andrewconnell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All looks good, but maybe one more edit for discoverability... add a callout maybe in this doc?

Copy link
Contributor

Learn Build status updates of commit 53326b3:

✅ Validation status: passed

File Status Preview URL Details
docs/apis/webhooks/sharepoint-webhooks-using-azd-template.md ✅Succeeded View
docs/apis/webhooks/sharepoint-webhooks-using-azure-functions.md ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:

@Yvand
Copy link
Contributor Author

Yvand commented Feb 27, 2025

This is a great suggestion, I updated https://learn.microsoft.com/sharepoint/dev/apis/webhooks/sharepoint-webhooks-using-azure-functions to add a reference to this new article, I hope the change is fine.

@jansenbe
Copy link
Contributor

@Yvand : Really nice work, thanks for this contribution!

@andrewconnell : I'm OK with merging this one

@andrewconnell andrewconnell added pr:ready-to-merge Ready to merge PR and removed Needs: Author Feedback Awaiting response from the original poster of the issue. Marked as stale if no activity for 7 days. pr:do-not-merge Pull request not ready to be merged labels Mar 5, 2025
@andrewconnell andrewconnell merged commit 201d50d into SharePoint:main Mar 5, 2025
2 checks passed
@Yvand Yvand deleted the yvamd/new-article-webhooks-azd branch March 5, 2025 10:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr:ready-to-merge Ready to merge PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants