alcionai / corso

Free, Secure, and Open-Source Backup for Microsoft 365

https://corsobackup.io

Apache License 2.0

182 stars 28 forks source link

docs: improve definition of a Backup #5316

Closed OrhanTozan closed 4 months ago

OrhanTozan commented 5 months ago

After some building, I realized that a backup is a snapshot of a resource, not the whole m365 service. Initially, I assumed that 1 backup takes the whole service per tenant (https://discord.com/channels/1022200980487557130/1022200981376745474/1231385151376719892). This doc update should help clear the confusion more.

Maybe there is a better way to word it, so any other suggestions are welcome.

Does this PR need a docs update or release note?

[x] :white_check_mark: Yes, it's included
[ ] :clock1: Yes, but in a later PR
[ ] :no_entry: No

Type of change

[ ] :sunflower: Feature
[ ] :bug: Bugfix
[x] :world_map: Documentation
[ ] :robot: Supportability/Tests
[ ] :computer: CI/Deployment
[ ] :broom: Tech Debt/Cleanup

Issue(s)

Test Plan

[ ] :muscle: Manual
[ ] :zap: Unit test
[ ] :green_heart: E2E

aviator-app[bot] commented 5 months ago

Current Aviator status

Aviator will automatically update this comment as the status of the PR changes. Comment /aviator refresh to force Aviator to re-examine your PR (or learn about other /aviator commands).

This PR was merged manually (without Aviator). Merging manually can negatively impact the performance of the queue. Consider using Aviator next time.

See the real-time status of this PR on the Aviator webapp.

Use the Aviator Chrome Extension to see the status of your PR within GitHub.

CLAassistant commented 5 months ago

All committers have signed the CLA.

OrhanTozan commented 4 months ago

@ashmrtn no problem, I added your apostrophe suggestion btw.

OrhanTozan commented 4 months ago

@ashmrtn any idea why the build fails? It's only a textual docs change.

ashmrtn commented 4 months ago

Sorry! I forgot GH can be weird about displaying actions sometimes. Looks like a line too long linting error

docs/setup/concepts.md:26:121 MD013/line-length Line length [Expected: 120; Actual: 138]

If you want to run the linter locally there's directions in a README in the website folder as well 😄

sonarcloud[bot] commented 4 months ago

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

OrhanTozan commented 4 months ago

@ashmrtn aha, ok. I couldn't find that error in the logs.

I fixed the line length.