From 713997e6337782b2a208f99150e1dcac8ac1cdf1 Mon Sep 17 00:00:00 2001 From: Abin Simon Date: Fri, 30 Sep 2022 15:28:14 +0530 Subject: [PATCH] Drop autogenerated docs from repo --- .github/workflows/docgen.yml | 58 ------------------- docs/docs/cli/corso_backup_create_exchange.md | 29 ---------- docs/docs/cli/corso_backup_create_onedrive.md | 27 --------- docs/docs/cli/corso_backup_delete_exchange.md | 27 --------- docs/docs/cli/corso_backup_delete_onedrive.md | 27 --------- .../docs/cli/corso_backup_details_exchange.md | 44 -------------- .../docs/cli/corso_backup_details_onedrive.md | 27 --------- docs/docs/cli/corso_backup_list_exchange.md | 26 --------- docs/docs/cli/corso_backup_list_onedrive.md | 26 --------- docs/docs/cli/corso_env.md | 26 --------- docs/docs/cli/corso_repo_connect_s3.md | 29 ---------- docs/docs/cli/corso_repo_init_s3.md | 29 ---------- docs/docs/cli/corso_restore_exchange.md | 44 -------------- docs/docs/cli/corso_restore_onedrive.md | 28 --------- 14 files changed, 447 deletions(-) delete mode 100644 .github/workflows/docgen.yml delete mode 100644 docs/docs/cli/corso_backup_create_exchange.md delete mode 100644 docs/docs/cli/corso_backup_create_onedrive.md delete mode 100644 docs/docs/cli/corso_backup_delete_exchange.md delete mode 100644 docs/docs/cli/corso_backup_delete_onedrive.md delete mode 100644 docs/docs/cli/corso_backup_details_exchange.md delete mode 100644 docs/docs/cli/corso_backup_details_onedrive.md delete mode 100644 docs/docs/cli/corso_backup_list_exchange.md delete mode 100644 docs/docs/cli/corso_backup_list_onedrive.md delete mode 100644 docs/docs/cli/corso_env.md delete mode 100644 docs/docs/cli/corso_repo_connect_s3.md delete mode 100644 docs/docs/cli/corso_repo_init_s3.md delete mode 100644 docs/docs/cli/corso_restore_exchange.md delete mode 100644 docs/docs/cli/corso_restore_onedrive.md diff --git a/.github/workflows/docgen.yml b/.github/workflows/docgen.yml deleted file mode 100644 index 8b78635165..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.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/ - - # 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/docs/docs/cli/corso_backup_create_exchange.md b/docs/docs/cli/corso_backup_create_exchange.md deleted file mode 100644 index adc74c25e7..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 [flags] -``` - -### Flags - -|Flag|Short|Default|Help| -|:----|:-----|:-------|:----| -|`--all`||`false`|Backup all Exchange data for all users| -|`--data`||`[]`|Select one or more types of data to backup: email, contacts, or events| -|`--help`|`-h`|`false`|help for exchange| -|`--user`||`[]`|Backup Exchange data by user ID; accepts * to select all users| - -### 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 fc9357a3b3..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 [flags] -``` - -### Flags - -|Flag|Short|Default|Help| -|:----|:-----|:-------|:----| -|`--help`|`-h`|`false`|help for onedrive| -|`--user`||`[]`|Backup OneDrive data by user ID; accepts * to select all users| - -### 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 f5b226ceab..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 [flags] -``` - -### Flags - -|Flag|Short|Default|Help| -|:----|:-----|:-------|:----| -|`--backup`|||ID of the backup containing the details to be shown| -|`--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 8569b386b9..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 [flags] -``` - -### Flags - -|Flag|Short|Default|Help| -|:----|:-----|:-------|:----| -|`--backup`|||ID of the backup containing the details to be shown| -|`--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 935e785102..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 [flags] -``` - -### Flags - -|Flag|Short|Default|Help| -|:----|:-----|:-------|:----| -|`--backup`|||ID of the backup containing the details to be shown| -|`--contact`||`[]`|Select backup details by contact ID; accepts * to select all contacts| -|`--contact-folder`||`[]`|Select backup details by contact folder ID; accepts * to select all contact folders| -|`--contact-name`|||Select backup details where the contact name contains this value| -|`--email`||`[]`|Select backup details by emails ID; accepts * to select all emails| -|`--email-folder`||`[]`|Select backup details by email folder ID; accepts * to select all email folders| -|`--email-received-after`|||Restore mail where the email was received after this datetime| -|`--email-received-before`|||Restore mail where the email was received before this datetime| -|`--email-sender`|||Restore mail where the email sender matches this user id| -|`--email-subject`|||Restore mail where the email subject lines contain this value| -|`--event`||`[]`|Select backup details by event ID; accepts * to select all events| -|`--event-calendar`||`[]`|Select backup details by event calendar ID; accepts * to select all events| -|`--event-organizer`|||Select backup details where the event organizer user id contains this value| -|`--event-recurs`|||Select backup details if the event recurs. Use `--event-recurs` false to select non-recurring events| -|`--event-starts-after`|||Select backup details where the event starts after this datetime| -|`--event-starts-before`|||Select backup details where the event starts before this datetime| -|`--event-subject`|||Select backup details where the event subject contains this value| -|`--help`|`-h`|`false`|help for exchange| -|`--user`||`[]`|Select backup details by user ID; accepts * to select all users| - -### 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 d19d57709e..0000000000 --- a/docs/docs/cli/corso_backup_details_onedrive.md +++ /dev/null @@ -1,27 +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 [flags] -``` - -### Flags - -|Flag|Short|Default|Help| -|:----|:-----|:-------|:----| -|`--backup`|||ID of the backup containing the details to be shown| -|`--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 c42533362d..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 [flags] -``` - -### Flags - -|Flag|Short|Default|Help| -|:----|:-----|:-------|:----| -|`--bucket`|||Name of the S3 bucket (required).| -|`--endpoint`||`s3.amazonaws.com`|Server endpoint for S3 communication.| -|`--help`|`-h`|`false`|help for s3| -|`--prefix`|||Prefix applied to objects in the bucket.| - -### 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 2270c608e3..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 [flags] -``` - -### Flags - -|Flag|Short|Default|Help| -|:----|:-----|:-------|:----| -|`--bucket`|||Name of the S3 bucket (required).| -|`--endpoint`||`s3.amazonaws.com`|Server endpoint for S3 communication.| -|`--help`|`-h`|`false`|help for s3| -|`--prefix`|||Prefix applied to objects in the bucket.| - -### 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 5684f33fb4..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 [flags] -``` - -### Flags - -|Flag|Short|Default|Help| -|:----|:-----|:-------|:----| -|`--backup`|||ID of the backup to restore| -|`--contact`||`[]`|Restore contacts by ID; accepts * to select all contacts| -|`--contact-folder`||`[]`|Restore all contacts within the folder ID; accepts * to select all contact folders| -|`--contact-name`|||Restore contacts where the contact name contains this value| -|`--email`||`[]`|Restore emails by ID; accepts * to select all emails| -|`--email-folder`||`[]`|Restore all emails by folder ID; accepts * to select all email folders| -|`--email-received-after`|||Restore mail where the email was received after this datetime| -|`--email-received-before`|||Restore mail where the email was received before this datetime| -|`--email-sender`|||Restore mail where the email sender matches this user id| -|`--email-subject`|||Restore mail where the email subject lines contain this value| -|`--event`||`[]`|Restore events by ID; accepts * to select all events| -|`--event-calendar`||`[]`|Restore events by calendar ID; accepts * to select all event calendars| -|`--event-organizer`|||Restore events where the event organizer user id contains this value| -|`--event-recurs`|||Restore events if the event recurs. Use `--event-recurs false` to select non-recurring events| -|`--event-starts-after`|||Restore events where the event starts after this datetime| -|`--event-starts-before`|||Restore events where the event starts before this datetime| -|`--event-subject`|||Restore events where the event subject contains this value| -|`--help`|`-h`|`false`|help for exchange| -|`--user`||`[]`|Restore all data by user ID; accepts * to select all users| - -### 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 1d8b3a2fcb..0000000000 --- a/docs/docs/cli/corso_restore_onedrive.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: corso restore onedrive -hide_title: true ---- -## corso restore onedrive - -Restore M365 OneDrive service data - -```bash -corso restore onedrive [flags] -``` - -### Flags - -|Flag|Short|Default|Help| -|:----|:-----|:-------|:----| -|`--backup`|||ID of the backup to restore| -|`--help`|`-h`|`false`|help for onedrive| -|`--user`||`[]`|Restore all data by user ID; accepts * to select all users| - -### 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|