Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs cli 2.0 #1079

Merged
merged 70 commits into from
Aug 5, 2024
Merged

Docs cli 2.0 #1079

merged 70 commits into from
Aug 5, 2024

Conversation

choir241
Copy link
Contributor

@choir241 choir241 commented Jun 28, 2024

What does this PR do?

  • Added a note/disclaimer about version near the top before we start talking about commands
    • Made it clear these docs are for version X of the CLI and will not work with previous version
    • Linked to how to update
  • Documented all the commands and params for SEO purposes
  • Created a page for each service that has init/pull/push support. Each page should contain
  1. Overview
  2. Init
  3. appwrite.json
  4. pull
  5. Push
  6. Commands (options)
  • Linked to CLI from other products to raise awareness about the CLI
  • Updated the Non-interactive page
    • Added section about github action (Documented it in a way that allows us to add other providers)
  • Added Additional options can be added to Commands or Non-Interactive

Test Plan

Manual Testing CLI commands

Related PRs and Issues

X

Have you read the Contributing Guidelines on issues?

Yes

choir241 added 18 commits June 24, 2024 10:29
…nce structure, move database general command syntax structure
…ntication page due to lack of pull, push or init support
…ation page due to lack of pull, push or init support
…s: functions, buckets, collections, projects, teams and topics. rename list to commands in commands docs.
Copy link

render bot commented Jun 28, 2024

@choir241 choir241 marked this pull request as draft June 28, 2024 17:08
@choir241 choir241 requested a review from stnguyen90 July 1, 2024 17:43
@choir241 choir241 marked this pull request as ready for review July 1, 2024 17:43
choir241 and others added 6 commits July 25, 2024 10:04
…o tabs with code snippet examples and update content. Remove console, health, migrations, and vcs from command-line/commands table. Update placeholder variables with arrows and wrap with strings. Replace Cloud for Appwrite functions. Move scoop install and cookie commands to windows tab for more relevancy. Move Providers section to bottom of docs and rename it to CI/CD. Add more detail to messaging command-line/topics commands section.
…Update content CLI sections in topics, buckets, and collections. Update Windows install tab with transition texs. Update placeholders variables with <> and quotes.
@choir241 choir241 requested a review from stnguyen90 July 26, 2024 14:18
Copy link
Contributor

@stnguyen90 stnguyen90 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please fix the build error.

@choir241 choir241 requested a review from stnguyen90 August 5, 2024 17:33
Copy link
Contributor

@stnguyen90 stnguyen90 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One more tiny fix!

src/routes/docs/tooling/command-line/teams/+page.markdoc Outdated Show resolved Hide resolved
@choir241 choir241 requested a review from stnguyen90 August 5, 2024 18:26
…partial url link. Change installation h2 to Getting started to avoide heading clash. Change The Appwrite ClI is a command-line application to The Appwrite Command Line Interface (CLI) is an application to explain what CLI is. Change title from Deploy <RESOURCE> with CLI to <RESOURCE> to match navigation.
@choir241 choir241 requested a review from stnguyen90 August 5, 2024 18:56
src/partials/cli-disclaimer.md Outdated Show resolved Hide resolved
@choir241 choir241 requested a review from stnguyen90 August 5, 2024 19:59
Copy link
Contributor

@stnguyen90 stnguyen90 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎉

@stnguyen90 stnguyen90 merged commit adedb31 into 1.6.x Aug 5, 2024
1 check passed
@stnguyen90 stnguyen90 deleted the docs-CLI-2.0 branch August 5, 2024 20:03
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.

4 participants