Documentation updates for M365 Archive for SPE containers#10729
Documentation updates for M365 Archive for SPE containers#10729andrewconnell merged 23 commits intoSharePoint:mainfrom
Conversation
Added sections for archived containers, including actions for archiving and reactivating containers, and updated the list of supported actions in SharePoint Admin Center.
Added information about enumerating archived containers and viewing the archived container page in SharePoint Embedded Admin.
PoliCheck Scan ReportThe following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans. ✅ No issues foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
|
Learn Build status updates of commit a63d680:
|
Updated API documentation links for archival functionality.
PoliCheck Scan ReportThe following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans. ✅ No issues foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
|
Learn Build status updates of commit 4262a85:
|
PoliCheck Scan ReportThe following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans. ✅ No issues foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
|
Learn Build status updates of commit 032f49e:
|
…support doc - correct grammar in metadata description - change H3 to H2 for proper heading hierarchy - replace "available here" link pattern - spell out numbers under 10 - remove trailing blank line
PoliCheck Scan ReportThe following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans. ✅ No issues foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
|
Learn Build status updates of commit d1bcde7:
|
andrewconnell
left a comment
andrewconnell
left a comment
There was a problem hiding this comment.
Please review all build warnings & suggestions... those are MSDOCS findings that need to be addressed before we can fully review the submission & merge the changes.
andrewconnell
added
Needs: Author Feedback
@andrewconnell There are images in the same folder with the naming convention thats followed here. Is that an issue still? |
In short, yes @ishwarit, it's an issue for this PR that must be resolved. Note, only the content within this PR is what my comment was about... now the other content you're referencing. While there's a LOT of legacy content in this repo that doesn't conform to the MSDOCS rules, we're cleaning it up over time. But new content like this must conform ot the MSDOCS rules, which is why it was flagged in the automated build. Eventually, warnings will be considered errors and block updates to the repo, this new content must meet the current issues. So, all the build issues in this PR must be resolved before we can review the content & consider it for merging. |
@andrewconnell Thanks for sharing the additional context. Just one more question: Are the issues marked as suggestion build blockers as well? |
|
@ishwarit If those files are existing pages and not new pages, then those don't have to be addressed as it's more complicated to create the redirects. Otherwise if they are new pages, yes they should be addressed. |
|
Learn Build status updates of commit 5ff1d0e:
|
PoliCheck Scan ReportThe following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans. ✅ No issues foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
Reuploaded with correct naming convention
PoliCheck Scan ReportThe following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans. ✅ No issues foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
|
Learn Build status updates of commit 6d1f69c:
|
PoliCheck Scan ReportThe following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans. ✅ No issues foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
|
Learn Build status updates of commit 381fd2a:
|
…ion.png Reuploaded with corrected naming convention.
Reuploaded with corrected naming convention.
…mation.png Reuploaded with corrected naming convention.
Reuploaded with corrected naming convention.
PoliCheck Scan ReportThe following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans. ✅ No issues foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
|
Learn Build status updates of commit 6431d2d:
|
PoliCheck Scan ReportThe following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans. ✅ No issues foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
|
Learn Build status updates of commit ed5cc84: 💡 Validation status: suggestionsdocs/embedded/development/support-archival-of-containers.md
docs/embedded/getting-started/m365-archive-support-for-containers.md
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 All the warnings are now fixed. |
@andrewconnell looking to close this as soon as possible as the feature rollout is complete. Can you please prioritize? |
andrewconnell
added
pr:in-review
andrewconnell
left a comment
andrewconnell
left a comment
There was a problem hiding this comment.
Before submitting a PR, please run it through Acrolinx for a MSFT Docs specific content review; for instance it found the following:
- always spell out Microsoft 365 (not 'M365')
- use allowed product names (Microsoft Cost Management, not Azure Cost Management)
- misspelled words
- grammatical errors
- don't use 'click', use 'select' (accessibility)
Always review preview rendering of docs:
- incorrect use of bullet points - always use
1.for ordered lists & let rendering engine fix them - fixed multiple indentation issues with images in numbered bullets
- http calls should be formatted as code (esp URLs so they aren't rendered as clickable links)
- command line args should be formatted as inline code
Reviewer fixing these, but future PR's should address these prior to review.
| ### [Meters](../billing/meters.md) | ||
|
|
||
| SharePoint Embedded employs a pay-as-you-go (PAYG) billing model through an Azure subscription. Billing is determined by how much data in GB you store in SharePoint Embedded, transactions used to access and modify the container and container contents, and data that is egressed from the SharePoint Embedded platform. Each of these factors contributes to the overall cost, ensuring that you only pay for the resources and services you use. You can view this usage and billing details in the [Azure Cost Management](https://ms.portal.azure.com/). | ||
| SharePoint Embedded employs a pay-as-you-go (PAYG) billing model through an Azure subscription. Billing is determined by how much data in GB you store in SharePoint Embedded in active and archived states, transactions used to access and modify the container and container contents, and data that is egressed from the SharePoint Embedded platform. Each of these factors contributes to the overall cost, ensuring that you only pay for the resources and services you use. You can view this usage and billing details in the [Azure Cost Management](https://ms.portal.azure.com/). |
There was a problem hiding this comment.
use allowed product names (Microsoft Cost Management, not Azure Cost Management)
| 1. Enumerate applications in a tenant | ||
| 1. Enumerate containers of an application in a tenant | ||
| 1. Enumerate containers of an application sorted by storage basis storage | ||
| 2. Enumerate archived containers of an application |
There was a problem hiding this comment.
incorrect use of bullet points - always use 1. for ordered lists & let rendering engine fix them
There was a problem hiding this comment.
always spell out Microsoft 365 (not 'M365')
There was a problem hiding this comment.
incorrect indentation causing incorrect rendering of numbered list
There was a problem hiding this comment.
incorrect indentation causing incorrect rendering of numbered list
| The following actions are supported in SharePoint Admin Center: | ||
|
|
||
| 1. View active containers in the tenant | ||
| 2. View archived containers in the tenant |
There was a problem hiding this comment.
incorrect use of bullet points - always use 1. for ordered lists & let rendering engine fix them
|
|
||
| |Action|API Documentation link|Example| | ||
| |--------|--------|-------| | ||
| |Archive an active container|[Archive](https://learn.microsoft.com/graph/api/filestoragecontainer-archive)|POST https://graph.microsoft.com/beta/storage/fileStorage/containers/{ContainerId}/archive| |
There was a problem hiding this comment.
- don't use absolute links to
learn.Microsoft.com; use relative - HTTP examples should be inline code formatted so links aren't automatically created in rendering
|
|
||
| # Onboard your application to support archival functionality | ||
|
|
||
| Archival of containers helps customers in reducing the cost of storing infrequently used data. Support archival in your application by enabling the -IsArchiveEnabled flag using the following PowerShell cmdlet. This cmdlet is supported only by the SharePoint Embedded administrator of your organization. |
There was a problem hiding this comment.
missing inline code formatting for posh arg
There was a problem hiding this comment.
comment from OP said this was an existing file so didn't rename file... that's not correct... this looks like a new file so it should be named correctly
docs/toc.yml
Outdated
| - name: Register Container Type API | ||
| href: embedded/getting-started/register-api-documentation.md | ||
| - name: Microsoft 365 Archive support for containers | ||
| href: embedded/getting-started/m365-archive-support-for-containers.md |
There was a problem hiding this comment.
incorrect reference to file
- fix numbered list markers to use consistent `1.` prefix - rename file to use full "microsoft-365" instead of "m365" - update "M365" references to "Microsoft 365" - fix markdown table alignment and formatting - replace "Azure Cost Management" with "Microsoft Cost Management" - fix trailing whitespace and minor wording improvements - format API links as relative paths and wrap examples in inline code
PoliCheck Scan ReportThe following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans. ✅ No issues foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
andrewconnell
added
pr:ready-to-merge
|
Thank you so much!!! @andrewconnell |
Yup! In the future, if you could review the edits I made when you submit updates, that will help in the reviews. I'm processing a few other PR's and making some other content updates, then I'll let the person who owns updating the live site know the |
2 participants
No description provided.