fad3dfe769
<!-- PR description--> * Attachment download needed an expand operation. Added that. * Added test coverage with gock. Tested with manual backup of posts which contain attachments(embedded/non-embedded). We can't add e2e tests with attachments, since API to create new conversations requires delegated access. * Note that https://github.com/alcionai/corso/issues/4991 is still an open item. We don't have a resolution for it right now, since attachment endpoint requires delegated token. Defaulting to let the backup fail for "too many attachments" error case. We don't know yet if we'd see that with group mailboxes, and whether it'd be the same error that we saw with exchange (recurring 503s). --- #### 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 - [x] 🐛 Bugfix - [ ] 🗺️ Documentation - [ ] 🤖 Supportability/Tests - [ ] 💻 CI/Deployment - [ ] 🧹 Tech Debt/Cleanup #### Issue(s) <!-- Can reference multiple issues. Use one of the following "magic words" - "closes, fixes" to auto-close the Github issue. --> * #<issue> #### Test Plan <!-- How will this be tested prior to merging.--> - [x] 💪 Manual - [x] ⚡ Unit test - [ ] 💚 E2E
Corso documentation
Corso documentation uses Docusaurus 2, a modern static website generator. Mermaid provides support for native diagrams in Markdown.
Requirements
Developing documentation for Corso requires the following tools on your machine:
make- Docker
Installation
make buildimage
Live documentation development
make dev
This command starts a local development server within the Docker container and will expose docs at http://localhost:3000.
Generating Corso CLI docs
make genclidocs
Corso's CLI documents are auto generated. This command explicitly triggers generating these docs. This step will happen automatically for the other commands where this is relevant.
Building static documentation
make build
This command generates static content into the build directory for integration with any static contents hosting service.
Serving static documentation
make serve
This command will serve the static content generated with make build at http://localhost:3000.
Style and linting
# Lint all docs
make check
# Lint specific files and/or folders
make check VALE_TARGET="README.md docs/concepts"
This command will lint all Markdown files and check them for style issues using the Docker container
Documentation platform development
make shell
Use this command to interactively (and temporarily!) change the contents or configuration of the live documentation container image (for example, when experimenting with new plugins).