Skip to content

[DCV-4163] [6.0] Document the datacoves CLI - #83

Open
fmercadop wants to merge 1 commit into
mainfrom
DCV-4163-datacoves-cli-docs-6-0
Open

fmercadop wants to merge 1 commit into
mainfrom
DCV-4163-datacoves-cli-docs-6-0

Conversation

@fmercadop

Copy link
Copy Markdown
Contributor

Summary

Full reference for the datacoves CLI as shipped in 6.0, checked against the CLI source in the production tag v6.0.202610191749.

  • Moved reference/airflow/datacoves-commands to reference/vscode/datacoves-cli. The CLI runs in VS Code, and check_size_folder has nothing to do with Airflow.
  • Covered every command: check_size_folder, my import, my pytest, my db-clean, my parse-logs and my api-key.
  • Left a client-side redirect at the old URL that keeps the #anchor. The page is unlisted and its canonical points to the new URL.
  • Updated internal links. This fixes the broken #datacoves-my-parse-logs link in dag-parse-times.md.
  • Fixed a typo in my-import.md.

airflow3-check is not included. It ships in 6.1 and will be documented in a separate PR.

Deploy: Cloudflare redirect

When this is deployed, add a 301 in Cloudflare (Rules → Redirect Rules → Single Redirects):

  • Filter: (http.host eq "docs.datacoves.com" and http.request.uri.path in {"/docs/reference/airflow/datacoves-commands" "/docs/reference/airflow/datacoves-commands/" "/docs/reference/airflow/datacoves-commands.html"})
  • Target: https://docs.datacoves.com/docs/reference/vscode/datacoves-cli, status 301, preserve query string

Don't enable it before the deploy, or it will redirect to a page that doesn't exist yet.

- Move the CLI reference from reference/airflow/datacoves-commands to
  reference/vscode/datacoves-cli and cover every command in 6.0:
  check_size_folder, my import, my pytest, my db-clean, my parse-logs
  and my api-key.
- Leave a redirect stub at the old URL that keeps the #anchor.
- Point internal links to the new page (fixes the broken
  #datacoves-my-parse-logs link).
- Fix a typo in the My Import how-to.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant