f509543856
## Description Introduces a Corso specific (more desirable) formatting for the auto generated documentation. More or less an adaptation or https://github.com/spf13/cobra/blob/main/doc/md_docs.go. Unfortunately the original package does not have sufficient hooks to allow for plugging in a new renderer. Other approaches considered: * [Override the UsageTemplate ](https://github.com/spf13/cobra/blob/main/user_guide.md#defining-your-own-help) - unfortunately does not apply to Markdown generation * Use a golang template for the docs output - unfortunately the `pflags` package does not have a suitable way of iterating over the flags that can be easily fed into a template. Follow on work: * ~~Styling of flags tables as part of docs rendering - Done~~ * Opens up possibility for flag ordering - need to set `pflags.SortFlags = false` before parsing the flags - https://github.com/alcionai/corso/issues/783 * Can simplify sidebar command maintenance by naming the rendered docs files line similar to `<Num>_corso_command1_command2` where `<Num>` can be set as annotation on the commands. Order in the navbar can be set as part of command authoring - https://github.com/alcionai/corso/issues/784 ## Type of change Please check the type of change your PR introduces: - [ ] 🌻 Feature - [ ] 🐛 Bugfix - [x] 🗺️ Documentation - [ ] 🤖 Test - [ ] 🐹 Trivial/Minor ## Issue(s) <!-- Can reference multiple issues. Use one of the following "magic words" - "closes, fixes" to auto-close the Github issue. --> * https://github.com/alcionai/corso/issues/536 * https://github.com/alcionai/corso/issues/528 ## Test Plan <!-- How will this be tested prior to merging.--> - [x] 💪 Manual - [ ] ⚡ Unit test - [ ] 💚 E2E
Corso
Corso is the first open-source tool that aims to assist IT admins with the critical task of protecting their Microsoft 365 data. It provides a reliable, secure, and efficient data protection engine. Admins decide where to store the backup data and have the flexibility to perform backups of their desired service through an intuitive interface. As Corso evolves, it can become a great building block for more complex data protection workflows.
Corso supports M365 Exchange, OneDrive, SharePoint, and Teams. Coverage for more services, possibly beyond M365, will expand based on the interest and needs of the community.
Getting Started
TODO - Link to the appropriate page in the published docs.
Building Corso
# Build a binary. Will be placed in bin/
./build/build.sh
# Build a container image
./build/build-container.sh
Containers
Corso images are hosted on ghrc.io.
Rolling release
docker pull ghcr.io/alcionai/corso:{SHA} --platform linux/arm64
Contribution Guidelines
TODO
Code of Conduct
It's important that our community is inclusive and respectful of everyone. We ask that all Corso users and contributors take a few minutes to review our Code of Conduct
License
TODO `