diff --git a/.github/workflows/_filechange_checker.yml b/.github/workflows/_filechange_checker.yml index 105a1b33d0..2738687283 100644 --- a/.github/workflows/_filechange_checker.yml +++ b/.github/workflows/_filechange_checker.yml @@ -3,9 +3,12 @@ name: Filechange Checker on: workflow_call: outputs: - fileschanged: + srcfileschanged: description: "'true' if src/** or .github/workflows/** files have changed in the branch" - value: ${{ jobs.file-change-check.outputs.fileschanged }} + value: ${{ jobs.file-change-check.outputs.srcfileschanged }} + docfileschanged: + description: "'true' if docs/** or src/** or .github/workflows/** files have changed in the branch" + value: ${{ jobs.file-change-check.outputs.docfileschanged }} jobs: file-change-check: @@ -14,7 +17,8 @@ jobs: contents: read pull-requests: read outputs: - fileschanged: ${{ steps.checker.outputs.fileschanged }} + srcfileschanged: ${{ steps.srcchecker.outputs.srcfileschanged }} + docfileschanged: ${{ steps.docchecker.outputs.docfileschanged }} steps: - uses: actions/checkout@v3 @@ -27,11 +31,21 @@ jobs: filters: | src: - 'src/**' + docs: + - 'docs/**' actions: - '.github/workflows/**' - - name: Check dorny for changes in specified filepaths - id: checker + + - name: Check dorny for changes in src filepaths + id: srcchecker if: steps.dornycheck.outputs.src == 'true' || steps.dornycheck.outputs.actions == 'true' run: | echo "src or workflow file changes occurred" - echo ::set-output name=fileschanged::true \ No newline at end of file + echo ::set-output name=srcfileschanged::true + + - name: Check dorny for changes in docs related filepaths + id: docchecker + if: steps.dornycheck.outputs.src == 'true' || steps.dornycheck.outputs.docs == 'true' || steps.dornycheck.outputs.actions == 'true' + run: | + echo "docs, src or workflow file changes occurred" + echo ::set-output name=docfileschanged::true \ No newline at end of file diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index bf69c077b8..a3d05edd0f 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -22,7 +22,7 @@ jobs: # --- Prechecks and Checkouts ------------------------------------------------------------------------ # ---------------------------------------------------------------------------------------------------- precheck: - uses: alcionai/corso/.github/workflows/_filechange_checker.yml@main + uses: alcionai/corso/.github/workflows/_filechange_checker.yml@docs-ci # TODO: change this to main checkout: needs: precheck @@ -35,7 +35,7 @@ jobs: - uses: actions/checkout@v3 - name: Setup Golang with cache - if: needs.precheck.outputs.fileschanged == 'true' + if: needs.precheck.outputs.srcfileschanged == 'true' uses: ./.github/actions/go-setup-cache with: go-version-file: src/go.mod @@ -55,7 +55,7 @@ jobs: - uses: actions/checkout@v3 - name: Setup Golang with cache - if: needs.precheck.outputs.fileschanged == 'true' + if: needs.precheck.outputs.srcfileschanged == 'true' uses: magnetikonline/action-golang-cache@v3 with: go-version-file: src/go.mod @@ -64,12 +64,12 @@ jobs: # Install gotestfmt - name: Set up gotestfmt - if: needs.precheck.outputs.fileschanged == 'true' + if: needs.precheck.outputs.srcfileschanged == 'true' run: go install github.com/haveyoudebuggedit/gotestfmt/v2/cmd/gotestfmt@latest # AWS creds - name: Configure AWS credentials from Test account - if: needs.precheck.outputs.fileschanged == 'true' + if: needs.precheck.outputs.srcfileschanged == 'true' uses: aws-actions/configure-aws-credentials@v1 with: role-to-assume: arn:aws:iam::951767375776:role/corso-testing-role @@ -78,7 +78,7 @@ jobs: # run the tests - name: Integration Tests - if: needs.precheck.outputs.fileschanged == 'true' + if: needs.precheck.outputs.srcfileschanged == 'true' env: CLIENT_ID: ${{ secrets.CLIENT_ID }} CLIENT_SECRET: ${{ secrets.CLIENT_SECRET }} @@ -95,7 +95,7 @@ jobs: # Upload the original go test log as an artifact for later review. - name: Upload test log - if: failure() && needs.precheck.outputs.fileschanged == 'true' + if: failure() && needs.precheck.outputs.srcfileschanged == 'true' uses: actions/upload-artifact@v3 with: name: test-log @@ -118,13 +118,13 @@ jobs: - uses: actions/checkout@v3 - name: Setup Golang with cache - if: needs.precheck.outputs.fileschanged == 'true' + if: needs.precheck.outputs.srcfileschanged == 'true' uses: magnetikonline/action-golang-cache@v3 with: go-version-file: src/go.mod - name: Go Lint - if: needs.precheck.outputs.fileschanged == 'true' + if: needs.precheck.outputs.srcfileschanged == 'true' uses: golangci/golangci-lint-action@v3 with: version: v1.45.2 @@ -133,9 +133,9 @@ jobs: # check licenses - name: Get go-licenses - if: needs.precheck.outputs.fileschanged == 'true' + if: needs.precheck.outputs.srcfileschanged == 'true' run: go install github.com/google/go-licenses@latest - name: Run go-licenses - if: needs.precheck.outputs.fileschanged == 'true' + if: needs.precheck.outputs.srcfileschanged == 'true' run: go-licenses check github.com/alcionai/corso/src --ignore github.com/alcionai/corso/src \ No newline at end of file diff --git a/.github/workflows/docgen.yml b/.github/workflows/docgen.yml deleted file mode 100644 index 34d98827de..0000000000 --- a/.github/workflows/docgen.yml +++ /dev/null @@ -1,58 +0,0 @@ -name: Document Generation -on: - push: - branches: [main] - -permissions: - contents: write - pull-requests: write - deployments: write - -jobs: - precheck: - uses: alcionai/corso/.github/workflows/_filechange_checker.yml@main - - Generate-Markdown: - needs: precheck - if: needs.precheck.outputs.fileschanged == 'true' - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v3 - with: - ref: ${{ github.event.pull_request.head.ref }} - - - name: Setup Golang with cache - uses: magnetikonline/action-golang-cache@v3 - with: - go-version-file: src/go.mod - - # run the markdown generator - - name: Generate Markdown - working-directory: ./src - run: | - go run ./cmd/mdgen/mdgen.go generate - - # migrate generated md files into /docs/docs/cli - - name: Move CLI .md to Docs - run: | - mkdir -p ./docs/docs/cli - mv ./src/cmd/mdgen/cli_markdown/* ./docs/docs/cli/ - rm -R ./src/cmd/mdgen/cli_markdown/ - - # make a PR for the docs_autogen branch - - name: Make a PR For the `docs_autogen` Branch - uses: peter-evans/create-pull-request@v4 - with: - commit-message: "Documentation Auto-Generation" - branch: docs_autogen - delete-branch: true - base: main - title: "Docs Auto-Generation" - - # make sure it gets approved - - name: Auto approve - if: steps.cpr.outputs.pull-request-operation == 'created' - uses: juliangruber/approve-pull-request-action@v1 - with: - github-token: ${{ secrets.GITHUB_TOKEN }} - number: ${{ steps.cpr.outputs.pull-request-number }} \ No newline at end of file diff --git a/.github/workflows/docs-ci.yml b/.github/workflows/docs-ci.yml new file mode 100644 index 0000000000..90d03749f9 --- /dev/null +++ b/.github/workflows/docs-ci.yml @@ -0,0 +1,81 @@ +name: CI Tests for docs +on: + push: + branches: [main] + pull_request: + branches: [main] + +permissions: + # required to retrieve AWS credentials + id-token: write + contents: write + pull-requests: read + +# cancel currently running jobs if a new version of the branch is pushed +concurrency: + group: docs-ci-${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +jobs: + + # ---------------------------------------------------------------------------------------------------- + # --- Precheck --------------------------------------------------------------------------------------- + # ---------------------------------------------------------------------------------------------------- + precheck: + uses: alcionai/corso/.github/workflows/_filechange_checker.yml@docs-ci # TODO: change this to main + + # ---------------------------------------------------------------------------------------------------- + # --- Generate cli docs ------------------------------------------------------------------------------ + # ---------------------------------------------------------------------------------------------------- + + Generate-Markdown: + needs: precheck + if: needs.precheck.outputs.srcfileschanged == 'true' + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + with: + ref: ${{ github.event.pull_request.head.ref }} + + - name: Setup Golang with cache + uses: magnetikonline/action-golang-cache@v3 + with: + go-version-file: src/go.mod + + # run the markdown generator + - name: Generate Markdown + working-directory: ./src + run: | + go run ./cmd/mdgen/mdgen.go generate + + # migrate generated md files into /docs/docs/cli + - name: Move CLI .md to Docs + run: | + mkdir -p ./docs/docs/cli + mv ./src/cmd/mdgen/cli_markdown/* ./docs/docs/cli/ + rm -R ./src/cmd/mdgen/cli_markdown/ + + # ---------------------------------------------------------------------------------------------------- + # --- Docs Linting ----------------------------------------------------------------------------------- + # ---------------------------------------------------------------------------------------------------- + + Docs-Linting: + needs: [precheck , Generate-Markdown] + environment: Testing + runs-on: ubuntu-latest + defaults: + run: + working-directory: docs + steps: + - uses: actions/checkout@v3 + + - name: Install dependencies for docs lint + if: needs.precheck.outputs.docfileschanged == 'true' + run: | + sudo snap install --edge vale + npm install -g markdownlint-cli + + - name: Run docs lint + if: needs.precheck.outputs.docfileschanged == 'true' + run: | + make -o genclidocs check \ No newline at end of file diff --git a/.github/workflows/image.yml b/.github/workflows/image.yml index 75da2b5988..49aee3194d 100644 --- a/.github/workflows/image.yml +++ b/.github/workflows/image.yml @@ -14,7 +14,7 @@ jobs: Per-SHA-Image: needs: precheck - if: needs.precheck.outputs.fileschanged == 'true' + if: needs.precheck.outputs.srcfileschanged == 'true' runs-on: ubuntu-latest defaults: run: diff --git a/.gitignore b/.gitignore index f3bb16eb27..34a35a40e1 100644 --- a/.gitignore +++ b/.gitignore @@ -24,4 +24,5 @@ /docker/bin /website/dist -*/test_results/** \ No newline at end of file +*/test_results/** +docs/docs/cli \ No newline at end of file diff --git a/docs/docs/cli/corso_backup_create_exchange.md b/docs/docs/cli/corso_backup_create_exchange.md deleted file mode 100644 index b7022caf37..0000000000 --- a/docs/docs/cli/corso_backup_create_exchange.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: corso backup create exchange -hide_title: true ---- -## corso backup create exchange - -Backup M365 Exchange service data - -```bash -corso backup create exchange --all | --user [flags] -``` - -### Flags - -|Flag|Short|Default|Help| -|:----|:-----|:-------|:----| -|`--all`||`false`|Backup all Exchange data for all users| -|`--user`||``|Backup Exchange data by user ID; accepts * to select all users| -|`--data`||``|Select one or more types of data to backup: email, contacts, or events| -|`--help`|`-h`|`false`|help for exchange| - -### Global and inherited flags - -|Flag|Short|Default|Help| -|:----|:-----|:-------|:----| -|`--config-file`||`$HOME/.corso.toml`|config file location (default is $HOME/.corso.toml)| -|`--json`||`false`|output data in JSON format| -|`--log-level`||`info`|set the log level to debug|info|warn|error| -|`--no-stats`||`false`|disable anonymous usage statistics gathering| diff --git a/docs/docs/cli/corso_backup_create_onedrive.md b/docs/docs/cli/corso_backup_create_onedrive.md deleted file mode 100644 index 2df53cc1db..0000000000 --- a/docs/docs/cli/corso_backup_create_onedrive.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: corso backup create onedrive -hide_title: true ---- -## corso backup create onedrive - -Backup M365 OneDrive service data - -```bash -corso backup create onedrive --user | * [flags] -``` - -### Flags - -|Flag|Short|Default|Help| -|:----|:-----|:-------|:----| -|`--user`||``|Backup OneDrive data by user ID; accepts * to select all users.
Required
| -|`--help`|`-h`|`false`|help for onedrive| - -### Global and inherited flags - -|Flag|Short|Default|Help| -|:----|:-----|:-------|:----| -|`--config-file`||`$HOME/.corso.toml`|config file location (default is $HOME/.corso.toml)| -|`--json`||`false`|output data in JSON format| -|`--log-level`||`info`|set the log level to debug|info|warn|error| -|`--no-stats`||`false`|disable anonymous usage statistics gathering| diff --git a/docs/docs/cli/corso_backup_delete_exchange.md b/docs/docs/cli/corso_backup_delete_exchange.md deleted file mode 100644 index 7f399d902b..0000000000 --- a/docs/docs/cli/corso_backup_delete_exchange.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: corso backup delete exchange -hide_title: true ---- -## corso backup delete exchange - -Delete backed-up M365 Exchange service data - -```bash -corso backup delete exchange --backup [flags] -``` - -### Flags - -|Flag|Short|Default|Help| -|:----|:-----|:-------|:----| -|`--backup`|||ID of the backup to delete.
Required
| -|`--help`|`-h`|`false`|help for exchange| - -### Global and inherited flags - -|Flag|Short|Default|Help| -|:----|:-----|:-------|:----| -|`--config-file`||`$HOME/.corso.toml`|config file location (default is $HOME/.corso.toml)| -|`--json`||`false`|output data in JSON format| -|`--log-level`||`info`|set the log level to debug|info|warn|error| -|`--no-stats`||`false`|disable anonymous usage statistics gathering| diff --git a/docs/docs/cli/corso_backup_delete_onedrive.md b/docs/docs/cli/corso_backup_delete_onedrive.md deleted file mode 100644 index 4fbcb63f8c..0000000000 --- a/docs/docs/cli/corso_backup_delete_onedrive.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: corso backup delete onedrive -hide_title: true ---- -## corso backup delete onedrive - -Delete backed-up M365 OneDrive service data - -```bash -corso backup delete onedrive --backup [flags] -``` - -### Flags - -|Flag|Short|Default|Help| -|:----|:-----|:-------|:----| -|`--backup`|||ID of the backup to delete.
Required
| -|`--help`|`-h`|`false`|help for onedrive| - -### Global and inherited flags - -|Flag|Short|Default|Help| -|:----|:-----|:-------|:----| -|`--config-file`||`$HOME/.corso.toml`|config file location (default is $HOME/.corso.toml)| -|`--json`||`false`|output data in JSON format| -|`--log-level`||`info`|set the log level to debug|info|warn|error| -|`--no-stats`||`false`|disable anonymous usage statistics gathering| diff --git a/docs/docs/cli/corso_backup_details_exchange.md b/docs/docs/cli/corso_backup_details_exchange.md deleted file mode 100644 index a13200f6cd..0000000000 --- a/docs/docs/cli/corso_backup_details_exchange.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: corso backup details exchange -hide_title: true ---- -## corso backup details exchange - -Shows the details of a M365 Exchange service backup - -```bash -corso backup details exchange --backup [flags] -``` - -### Flags - -|Flag|Short|Default|Help| -|:----|:-----|:-------|:----| -|`--backup`|||ID of the backup to explore.
Required
| -|`--user`||``|Select backup details by user ID; accepts * to select all users.| -|`--email`||``|Select backup details for emails by email ID; accepts * to select all emails.| -|`--email-folder`||``|Select backup details for emails within a folder; accepts * to select all email folders.| -|`--email-subject`|||Select backup details for emails with a subject containing this value.| -|`--email-sender`|||Select backup details for emails from a specific sender.| -|`--email-received-after`|||Select backup details for emails received after this datetime.| -|`--email-received-before`|||Select backup details for emails received before this datetime.| -|`--event`||``|Select backup details for events by event ID; accepts * to select all events.| -|`--event-calendar`||``|Select backup details for events under a calendar; accepts * to select all events.| -|`--event-subject`|||Select backup details for events with a subject containing this value.| -|`--event-organizer`|||Select backup details for events from a specific organizer.| -|`--event-recurs`|||Select backup details for recurring events. Use `--event-recurs false` to select non-recurring events.| -|`--event-starts-after`|||Select backup details for events starting after this datetime.| -|`--event-starts-before`|||Select backup details for events starting before this datetime.| -|`--contact`||``|Select backup details for contacts by contact ID; accepts * to select all contacts.| -|`--contact-folder`||``|Select backup details for contacts within a folder; accepts * to select all contact folders.| -|`--contact-name`|||Select backup details for contacts whose contact name contains this value.| -|`--help`|`-h`|`false`|help for exchange| - -### Global and inherited flags - -|Flag|Short|Default|Help| -|:----|:-----|:-------|:----| -|`--config-file`||`$HOME/.corso.toml`|config file location (default is $HOME/.corso.toml)| -|`--json`||`false`|output data in JSON format| -|`--log-level`||`info`|set the log level to debug|info|warn|error| -|`--no-stats`||`false`|disable anonymous usage statistics gathering| diff --git a/docs/docs/cli/corso_backup_details_onedrive.md b/docs/docs/cli/corso_backup_details_onedrive.md deleted file mode 100644 index 2a7c780634..0000000000 --- a/docs/docs/cli/corso_backup_details_onedrive.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: corso backup details onedrive -hide_title: true ---- -## corso backup details onedrive - -Shows the details of a M365 OneDrive service backup - -```bash -corso backup details onedrive --backup [flags] -``` - -### Flags - -|Flag|Short|Default|Help| -|:----|:-----|:-------|:----| -|`--backup`|||ID of the backup to explore.
Required
| -|`--folder`||``|Select backup details by OneDrive folder; defaults to root| -|`--file-name`||``|Select backup details by OneDrive file name| -|`--file-created-after`|||Select files created after this datetime| -|`--file-created-before`|||Select files created before this datetime| -|`--file-modified-after`|||Select files modified after this datetime| -|`--file-modified-before`|||Select files modified before this datetime| -|`--help`|`-h`|`false`|help for onedrive| - -### Global and inherited flags - -|Flag|Short|Default|Help| -|:----|:-----|:-------|:----| -|`--config-file`||`$HOME/.corso.toml`|config file location (default is $HOME/.corso.toml)| -|`--json`||`false`|output data in JSON format| -|`--log-level`||`info`|set the log level to debug|info|warn|error| -|`--no-stats`||`false`|disable anonymous usage statistics gathering| diff --git a/docs/docs/cli/corso_backup_list_exchange.md b/docs/docs/cli/corso_backup_list_exchange.md deleted file mode 100644 index 1d388e30d5..0000000000 --- a/docs/docs/cli/corso_backup_list_exchange.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: corso backup list exchange -hide_title: true ---- -## corso backup list exchange - -List the history of M365 Exchange service backups - -```bash -corso backup list exchange [flags] -``` - -### Flags - -|Flag|Short|Default|Help| -|:----|:-----|:-------|:----| -|`--help`|`-h`|`false`|help for exchange| - -### Global and inherited flags - -|Flag|Short|Default|Help| -|:----|:-----|:-------|:----| -|`--config-file`||`$HOME/.corso.toml`|config file location (default is $HOME/.corso.toml)| -|`--json`||`false`|output data in JSON format| -|`--log-level`||`info`|set the log level to debug|info|warn|error| -|`--no-stats`||`false`|disable anonymous usage statistics gathering| diff --git a/docs/docs/cli/corso_backup_list_onedrive.md b/docs/docs/cli/corso_backup_list_onedrive.md deleted file mode 100644 index 6706a88221..0000000000 --- a/docs/docs/cli/corso_backup_list_onedrive.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: corso backup list onedrive -hide_title: true ---- -## corso backup list onedrive - -List the history of M365 OneDrive service backups - -```bash -corso backup list onedrive [flags] -``` - -### Flags - -|Flag|Short|Default|Help| -|:----|:-----|:-------|:----| -|`--help`|`-h`|`false`|help for onedrive| - -### Global and inherited flags - -|Flag|Short|Default|Help| -|:----|:-----|:-------|:----| -|`--config-file`||`$HOME/.corso.toml`|config file location (default is $HOME/.corso.toml)| -|`--json`||`false`|output data in JSON format| -|`--log-level`||`info`|set the log level to debug|info|warn|error| -|`--no-stats`||`false`|disable anonymous usage statistics gathering| diff --git a/docs/docs/cli/corso_env.md b/docs/docs/cli/corso_env.md deleted file mode 100644 index b58f9d0b63..0000000000 --- a/docs/docs/cli/corso_env.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: corso env -hide_title: true ---- -## corso env - -A guide to using environment variables in Corso. - -```bash -corso env [flags] -``` - -### Flags - -|Flag|Short|Default|Help| -|:----|:-----|:-------|:----| -|`--help`|`-h`|`false`|help for env| - -### Global and inherited flags - -|Flag|Short|Default|Help| -|:----|:-----|:-------|:----| -|`--config-file`||`$HOME/.corso.toml`|config file location (default is $HOME/.corso.toml)| -|`--json`||`false`|output data in JSON format| -|`--log-level`||`info`|set the log level to debug|info|warn|error| -|`--no-stats`||`false`|disable anonymous usage statistics gathering| diff --git a/docs/docs/cli/corso_repo_connect_s3.md b/docs/docs/cli/corso_repo_connect_s3.md deleted file mode 100644 index 4c49a1b3fa..0000000000 --- a/docs/docs/cli/corso_repo_connect_s3.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: corso repo connect s3 -hide_title: true ---- -## corso repo connect s3 - -Ensures a connection to an existing S3 repository. - -```bash -corso repo connect s3 --bucket [flags] -``` - -### Flags - -|Flag|Short|Default|Help| -|:----|:-----|:-------|:----| -|`--bucket`|||Name of S3 bucket for repo.
Required
| -|`--prefix`|||Repo prefix within bucket.| -|`--endpoint`||`s3.amazonaws.com`|S3 service endpoint.| -|`--help`|`-h`|`false`|help for s3| - -### Global and inherited flags - -|Flag|Short|Default|Help| -|:----|:-----|:-------|:----| -|`--config-file`||`$HOME/.corso.toml`|config file location (default is $HOME/.corso.toml)| -|`--json`||`false`|output data in JSON format| -|`--log-level`||`info`|set the log level to debug|info|warn|error| -|`--no-stats`||`false`|disable anonymous usage statistics gathering| diff --git a/docs/docs/cli/corso_repo_init_s3.md b/docs/docs/cli/corso_repo_init_s3.md deleted file mode 100644 index 3349ad14d4..0000000000 --- a/docs/docs/cli/corso_repo_init_s3.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: corso repo init s3 -hide_title: true ---- -## corso repo init s3 - -Bootstraps a new S3 repository and connects it to your m356 account. - -```bash -corso repo init s3 --bucket [flags] -``` - -### Flags - -|Flag|Short|Default|Help| -|:----|:-----|:-------|:----| -|`--bucket`|||Name of S3 bucket for repo.
Required
| -|`--prefix`|||Repo prefix within bucket.| -|`--endpoint`||`s3.amazonaws.com`|S3 service endpoint.| -|`--help`|`-h`|`false`|help for s3| - -### Global and inherited flags - -|Flag|Short|Default|Help| -|:----|:-----|:-------|:----| -|`--config-file`||`$HOME/.corso.toml`|config file location (default is $HOME/.corso.toml)| -|`--json`||`false`|output data in JSON format| -|`--log-level`||`info`|set the log level to debug|info|warn|error| -|`--no-stats`||`false`|disable anonymous usage statistics gathering| diff --git a/docs/docs/cli/corso_restore_exchange.md b/docs/docs/cli/corso_restore_exchange.md deleted file mode 100644 index 640707430f..0000000000 --- a/docs/docs/cli/corso_restore_exchange.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: corso restore exchange -hide_title: true ---- -## corso restore exchange - -Restore M365 Exchange service data - -```bash -corso restore exchange --backup [flags] -``` - -### Flags - -|Flag|Short|Default|Help| -|:----|:-----|:-------|:----| -|`--backup`|||ID of the backup to restore.
Required
| -|`--user`||``|Restore data by user ID; accepts * to select all users.| -|`--email`||``|Restore emails by ID; accepts * to select all emails.| -|`--email-folder`||``|Restore emails within a folder; accepts * to select all email folders.| -|`--email-subject`|||Restore emails with a subject containing this value.| -|`--email-sender`|||Restore emails from a specific sender.| -|`--email-received-after`|||Restore emails received after this datetime.| -|`--email-received-before`|||Restore emails received before this datetime.| -|`--event`||``|Restore events by event ID; accepts * to select all events.| -|`--event-calendar`||``|Restore events under a calendar; accepts * to select all event calendars.| -|`--event-subject`|||Restore events with a subject containing this value.| -|`--event-organizer`|||Restore events from a specific organizer.| -|`--event-recurs`|||Restore recurring events. Use `--event-recurs false` to restore non-recurring events.| -|`--event-starts-after`|||Restore events starting after this datetime.| -|`--event-starts-before`|||Restore events starting before this datetime.| -|`--contact`||``|Restore contacts by contact ID; accepts * to select all contacts.| -|`--contact-folder`||``|Restore contacts within a folder; accepts * to select all contact folders.| -|`--contact-name`|||Restore contacts whose contact name contains this value.| -|`--help`|`-h`|`false`|help for exchange| - -### Global and inherited flags - -|Flag|Short|Default|Help| -|:----|:-----|:-------|:----| -|`--config-file`||`$HOME/.corso.toml`|config file location (default is $HOME/.corso.toml)| -|`--json`||`false`|output data in JSON format| -|`--log-level`||`info`|set the log level to debug|info|warn|error| -|`--no-stats`||`false`|disable anonymous usage statistics gathering| diff --git a/docs/docs/cli/corso_restore_onedrive.md b/docs/docs/cli/corso_restore_onedrive.md deleted file mode 100644 index 9b4ad5be61..0000000000 --- a/docs/docs/cli/corso_restore_onedrive.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: corso restore onedrive -hide_title: true ---- -## corso restore onedrive - -Restore M365 OneDrive service data - -```bash -corso restore onedrive --backup [flags] -``` - -### Flags - -|Flag|Short|Default|Help| -|:----|:-----|:-------|:----| -|`--backup`|||ID of the backup to restore.
Required
| -|`--user`||``|Restore data by user ID; accepts * to select all users.| -|`--folder`||``|Restore items by OneDrive folder; defaults to root| -|`--file-name`||``|Restore items by OneDrive file name| -|`--file-created-after`|||Restore files created after this datetime| -|`--file-created-before`|||Restore files created before this datetime| -|`--file-modified-after`|||Restore files modified after this datetime| -|`--file-modified-before`|||Restore files modified before this datetime| -|`--help`|`-h`|`false`|help for onedrive| - -### Global and inherited flags - -|Flag|Short|Default|Help| -|:----|:-----|:-------|:----| -|`--config-file`||`$HOME/.corso.toml`|config file location (default is $HOME/.corso.toml)| -|`--json`||`false`|output data in JSON format| -|`--log-level`||`info`|set the log level to debug|info|warn|error| -|`--no-stats`||`false`|disable anonymous usage statistics gathering| diff --git a/docs/styles/Vocab/Base/accept.txt b/docs/styles/Vocab/Base/accept.txt index ebc30b679e..ac3eb90794 100644 --- a/docs/styles/Vocab/Base/accept.txt +++ b/docs/styles/Vocab/Base/accept.txt @@ -5,4 +5,5 @@ Config datetime (?i)OneDrive [Rr]epo -env \ No newline at end of file +env +src \ No newline at end of file