Skip to content

Create migration-job-progress-api-reference.md #10303

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

shiongzuo
Copy link
Contributor

Category

  • Content fix
  • New article

Related issues

  • N/A

What's in this Pull Request?

This PR introduces a new document that describes the GetMigrationJobProgress API and its usage.

Copy link
Contributor

Learn Build status updates of commit 3f9ca3d:

⚠️ Validation status: warnings

File Status Preview URL Details
docs/apis/migration-job-progress-api-reference.md ⚠️Warning View Details

docs/apis/migration-job-progress-api-reference.md

  • Line 22, Column 1: [Warning: multiple-h1s - See documentation] Multiple H1s(H1 'Permissions') are not allowed. You can only have one top-level heading.
  • Line 25, Column 1: [Warning: multiple-h1s - See documentation] Multiple H1s(H1 'GetMigrationJobProgress Method (SDK)') are not allowed. You can only have one top-level heading.
  • Line 48, Column 1: [Warning: duplicate-h2s - See documentation] Duplicate heading: 'H2 'Example''. Each second level heading (H2) in an article must be unique.
  • Line 56, Column 1: [Warning: multiple-h1s - See documentation] Multiple H1s(H1 'GetMigrationJobProgress REST API') are not allowed. You can only have one top-level heading.
  • Line 92, Column 1: [Warning: duplicate-h2s - See documentation] Duplicate heading: 'H2 'Example''. Each second level heading (H2) in an article must be unique.
  • Line 144, Column 1: [Warning: multiple-h1s - See documentation] Multiple H1s(H1 'Best Practice') are not allowed. You can only have one top-level heading.
  • Line 149, Column 1: [Warning: multiple-h1s - See documentation] Multiple H1s(H1 'See Also') are not allowed. You can only have one top-level heading.
  • Line 147, Column 116: [Suggestion: learn-site-link-broken - See documentation] Link '/docs/general-development/how-to-avoid-getting-throttled-or-blocked-in-sharepoint-online.md' points to a learn site page that doesn't exist. Check the path or URL and update the link.
  • Line 150, Column 1: [Suggestion: learn-site-link-broken - See documentation] Link '/docs/apis/migration-api-overview.md' points to a learn site page that doesn't exist. Check the path or URL and update the link.
  • Line 152, Column 1: [Suggestion: learn-site-link-broken - See documentation] Link '/docs/apis/migration-events.md' points to a learn site page that doesn't exist. Check the path or URL and update the link.
  • Line 154, Column 1: [Suggestion: learn-site-link-broken - See documentation] Link '/docs/general-development/how-to-avoid-getting-throttled-or-blocked-in-sharepoint-online.md' points to a learn site page that doesn't exist. Check the path or URL and update the 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.

@andrewconnell andrewconnell self-assigned this Jun 18, 2025
@andrewconnell andrewconnell added the pr:in-review Actively reviewing pull request label Jun 18, 2025
@andrewconnell
Copy link
Collaborator

This submission has multiple issues that must be fixed before we can review it for merge into the main docs - please address all findings in the build report.

Also, is this doc referenced anywhere? That's not part of this PR, so no one will see this from the docs... only from search. If it should be added to the TOC, please do that as part of this PR.

@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 Jun 18, 2025
Copy link
Contributor

Learn Build status updates of commit 0519ed8:

💡 Validation status: suggestions

File Status Preview URL Details
docs/apis/migration-job-progress-api-reference.md 💡Suggestion View Details

docs/apis/migration-job-progress-api-reference.md

  • Line 147, Column 116: [Suggestion: learn-site-link-broken - See documentation] Link '/docs/general-development/how-to-avoid-getting-throttled-or-blocked-in-sharepoint-online.md' points to a learn site page that doesn't exist. Check the path or URL and update the 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.

Copy link
Contributor

Learn Build status updates of commit 5b2d4d3:

⚠️ Validation status: warnings

File Status Preview URL Details
docs/apis/migration-job-progress-api-reference.md ⚠️Warning View Details

docs/apis/migration-job-progress-api-reference.md

  • Line 147, Column 116: [Warning: hard-coded-locale - See documentation] Link 'https://learn.microsoft.com/en-us/sharepoint/dev/general-development/how-to-avoid-getting-throttled-or-blocked-in-sharepoint-online' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
  • Line 150, Column 1: [Warning: hard-coded-locale - See documentation] Link 'https://learn.microsoft.com/en-us/sharepoint/dev/apis/migration-api-overview' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
  • Line 152, Column 1: [Warning: hard-coded-locale - See documentation] Link 'https://learn.microsoft.com/en-us/sharepoint/dev/apis/migration-events' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
  • Line 147, Column 116: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://learn.microsoft.com/en-us/sharepoint/dev/general-development/how-to-avoid-getting-throttled-or-blocked-in-sharepoint-online' will be broken in isolated environments. Replace with a relative link.
  • Line 150, Column 1: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://learn.microsoft.com/en-us/sharepoint/dev/apis/migration-api-overview' will be broken in isolated environments. Replace with a relative link.
  • Line 152, Column 1: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://learn.microsoft.com/en-us/sharepoint/dev/apis/migration-events' 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.

Copy link
Contributor

Learn Build status updates of commit 043845b:

✅ Validation status: passed

File Status Preview URL Details
docs/apis/migration-job-progress-api-reference.md ✅Succeeded View

For more details, please refer to the build report.

@shiongzuo
Copy link
Contributor Author

This submission has multiple issues that must be fixed before we can review it for merge into the main docs - please address all findings in the build report.

Also, is this doc referenced anywhere? That's not part of this PR, so no one will see this from the docs... only from search. If it should be added to the TOC, please do that as part of this PR.

@andrewconnell The warnings in this PR have been fixed. Please take a look.

Regarding doc reference, this PR only covers a new API. I will add references to this page in a list of other pages. This is meant to be consistent with PR modularity. But revision to other pages will depend on publishing this page.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants