adds documentation for sharepoint lists (#5099)

adds documentation for sharepoint lists.
should go in after: https://github.com/alcionai/corso/pull/5048

#### Does this PR need a docs update or release note?

- [x]  Yes, it's included
- [ ] 🕐 Yes, but in a later PR
- [ ]  No

#### Type of change

<!--- Please check the type of change your PR introduces: --->
- [ ] 🌻 Feature
- [ ] 🐛 Bugfix
- [x] 🗺️ Documentation
- [ ] 🤖 Supportability/Tests
- [ ] 💻 CI/Deployment
- [ ] 🧹 Tech Debt/Cleanup

#### Issue(s)
#4754 

#### Test Plan

<!-- How will this be tested prior to merging.-->
- [ ] 💪 Manual
- [ ]  Unit test
- [ ] 💚 E2E
This commit is contained in:
Hitesh Pattanayak 2024-01-30 16:05:09 +05:30 committed by GitHub
parent f615198c78
commit f1406a3334
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
9 changed files with 110 additions and 4 deletions

View File

@ -37,7 +37,11 @@ corso backup create sharepoint --site https://example.com/hr
corso backup create sharepoint --site https://example.com/hr,https://example.com/team corso backup create sharepoint --site https://example.com/hr,https://example.com/team
# Backup all SharePoint data for all Sites # Backup all SharePoint data for all Sites
corso backup create sharepoint --site '*'` corso backup create sharepoint --site '*'
# Backup all SharePoint list data for a Site
corso backup create sharepoint --site https://example.com/hr --data lists
`
sharePointServiceCommandDeleteExamples = `# Delete SharePoint backup with ID 1234abcd-12ab-cd34-56de-1234abcd \ sharePointServiceCommandDeleteExamples = `# Delete SharePoint backup with ID 1234abcd-12ab-cd34-56de-1234abcd \
and 1234abcd-12ab-cd34-56de-1234abce and 1234abcd-12ab-cd34-56de-1234abce
@ -57,7 +61,26 @@ corso backup details sharepoint --backup 1234abcd-12ab-cd34-56de-1234abcd \
# Explore all files within the document library "Work Documents" # Explore all files within the document library "Work Documents"
corso backup details sharepoint --backup 1234abcd-12ab-cd34-56de-1234abcd \ corso backup details sharepoint --backup 1234abcd-12ab-cd34-56de-1234abcd \
--library "Work Documents" --library "Work Documents"
`
# Explore lists by their name(s)
corso backup details sharepoint --backup 1234abcd-12ab-cd34-56de-1234abcd \
--list "list-name-1,list-name-2"
# Explore lists created after a given time
corso backup details sharepoint --backup 1234abcd-12ab-cd34-56de-1234abcd \
--list-created-after 2024-01-01T12:23:34
# Explore lists created before a given time
corso backup details sharepoint --backup 1234abcd-12ab-cd34-56de-1234abcd \
--list-created-before 2024-01-01T12:23:34
# Explore lists modified before a given time
corso backup details sharepoint --backup 1234abcd-12ab-cd34-56de-1234abcd \
--list-modified-before 2024-01-01T12:23:34
# Explore lists modified after a given time
corso backup details sharepoint --backup 1234abcd-12ab-cd34-56de-1234abcd \
--list-modified-after 2024-01-01T12:23:34`
) )
// called by backup.go to map subcommands to provider-specific handling. // called by backup.go to map subcommands to provider-specific handling.

View File

@ -45,7 +45,27 @@ corso export sharepoint --backup 1234abcd-12ab-cd34-56de-1234abcd \
# Export all files in the "Documents" library to the current directory. # Export all files in the "Documents" library to the current directory.
corso export sharepoint --backup 1234abcd-12ab-cd34-56de-1234abcd \ corso export sharepoint --backup 1234abcd-12ab-cd34-56de-1234abcd \
--library Documents --folder "Display Templates/Style Sheets" .` --library Documents --folder "Display Templates/Style Sheets" .
# Export lists by their name(s)
corso export sharepoint --backup 1234abcd-12ab-cd34-56de-1234abcd \
--list "list-name-1,list-name-2" .
# Export lists created after a given time
corso export sharepoint --backup 1234abcd-12ab-cd34-56de-1234abcd \
--list-created-after 2024-01-01T12:23:34 .
# Export lists created before a given time
corso export sharepoint --backup 1234abcd-12ab-cd34-56de-1234abcd \
--list-created-before 2024-01-01T12:23:34 .
# Export lists modified before a given time
corso export sharepoint --backup 1234abcd-12ab-cd34-56de-1234abcd \
--list-modified-before 2024-01-01T12:23:34 .
# Export lists modified after a given time
corso export sharepoint --backup 1234abcd-12ab-cd34-56de-1234abcd \
--list-modified-after 2024-01-01T12:23:34 .`
) )
// `corso export sharepoint [<flag>...] <destination>` // `corso export sharepoint [<flag>...] <destination>`

View File

@ -50,7 +50,27 @@ corso restore sharepoint --backup 1234abcd-12ab-cd34-56de-1234abcd \
# Restore all files in the "Documents" library. # Restore all files in the "Documents" library.
corso restore sharepoint --backup 1234abcd-12ab-cd34-56de-1234abcd \ corso restore sharepoint --backup 1234abcd-12ab-cd34-56de-1234abcd \
--library Documents --folder "Display Templates/Style Sheets" ` --library Documents --folder "Display Templates/Style Sheets"
# Restore lists by their name(s)
corso restore sharepoint --backup 1234abcd-12ab-cd34-56de-1234abcd \
--list "list-name-1,list-name-2"
# Restore lists created after a given time
corso restore sharepoint --backup 1234abcd-12ab-cd34-56de-1234abcd \
--list-created-after 2024-01-01T12:23:34
# Restore lists created before a given time
corso restore sharepoint --backup 1234abcd-12ab-cd34-56de-1234abcd \
--list-created-before 2024-01-01T12:23:34
# Restore lists modified before a given time
corso restore sharepoint --backup 1234abcd-12ab-cd34-56de-1234abcd \
--list-modified-before 2024-01-01T12:23:34
# Restore lists modified after a given time
corso restore sharepoint --backup 1234abcd-12ab-cd34-56de-1234abcd \
--list-modified-after 2024-01-01T12:23:34`
) )
// `corso restore sharepoint [<flag>...]` // `corso restore sharepoint [<flag>...]`

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 23 KiB

View File

@ -45,3 +45,43 @@ Next, file a [GitHub issue](https://github.com/alcionai/corso/issues/) with the
([default log file](../../setup/configuration/#log-files) and `corso-gc.log`, the Corso GC log file, from above) and ([default log file](../../setup/configuration/#log-files) and `corso-gc.log`, the Corso GC log file, from above) and
information on the size of the Exchange mailbox, OneDrive location, or SharePoint site that you are having an issue information on the size of the Exchange mailbox, OneDrive location, or SharePoint site that you are having an issue
with. with.
## Sharepoint List Anomalies
Some columns in sharepoint list aren't recognizable from the GRAPH API response.
More about this issue [here](https://github.com/alcionai/corso/issues/5166).
Therefore while `restore` of these columns, we default them to as text fields.
The value they hold are therefore not reinstated to the way the originally were.
<Tabs groupId="columns">
<TabItem value="hyp" label="Hyperlink">
### Originally created hyperlink column in Site
![diagram of list with Hyperlink column in a site](../../blog/images/Hyperlink-Column.png)
### Restored hyperlink column
![diagram of restored list with Hyperlink column in a site](../../blog/images/Restored-Hyperlink-Column.png)
### Issue tracker for hyperlink column support
To track progress, [visit](https://github.com/microsoftgraph/msgraph-sdk-go/issues/640).
</TabItem>
<TabItem value="loc" label="Location">
### Originally created location column in Site
![diagram of list with Location column in a site](../../blog/images/Location-Column.png)
### Restored location column
![diagram of restored list with Location column in a site](../../blog/images/Restored-Location-Column.png)
### Issue tracker for location column support
To track progress, [visit](https://github.com/microsoftgraph/msgraph-sdk-go/issues/638).
</TabItem>
</Tabs>

View File

@ -45,3 +45,6 @@ Below is a list of known Corso issues and limitations:
* In-place Exchange contacts restore will merge items in folders named "Contacts" or "contacts" into the default folder. * In-place Exchange contacts restore will merge items in folders named "Contacts" or "contacts" into the default folder.
* External users with access through shared links won't receive these links as they're not sent via email during restore. * External users with access through shared links won't receive these links as they're not sent via email during restore.
* Sharepoint list item "attachments" aren't backed up, restored or exported as
graph APIs doesn't currently provide attachment data for Lists or List Items.