Docs update cli 2.0 #1250
Docs update cli 2.0 #1250
Conversation
…using email, password, and otp as parameters
…with cli commands functionality.
|
The preview deployment is ready. 🟢 Open Preview | Open Build Logs Last updated at: 2024-09-03 15:33:28 CET |
src/routes/docs/tooling/command-line/installation/+page.markdoc
Outdated
Show resolved
Hide resolved
src/routes/docs/tooling/command-line/non-interactive/+page.markdoc
Outdated
Show resolved
Hide resolved
src/routes/docs/tooling/command-line/non-interactive/+page.markdoc
Outdated
Show resolved
Hide resolved
src/routes/docs/tooling/command-line/non-interactive/+page.markdoc
Outdated
Show resolved
Hide resolved
Co-authored-by: Matej Bačo <[email protected]>
…kdoc Co-authored-by: Matej Bačo <[email protected]>
…ub-section email and password and Api keys. Remove mentions of OTP.
src/routes/docs/tooling/command-line/non-interactive/+page.markdoc
Outdated
Show resolved
Hide resolved
src/routes/docs/tooling/command-line/non-interactive/+page.markdoc
Outdated
Show resolved
Hide resolved
src/routes/docs/tooling/command-line/non-interactive/+page.markdoc
Outdated
Show resolved
Hide resolved
src/routes/docs/tooling/command-line/non-interactive/+page.markdoc
Outdated
Show resolved
Hide resolved
|
|
||
| # Authentication {% #authentication %} | ||
|
|
||
| In non-interactive mode, you can authenticate your users using two methods: email and password. While using an [API key](/docs/advanced/platform/api-keys) does not require an email and password to authenticate users, you need to configure the API key [scopes](/docs/advanced/platform/api-keys#scopes) of the application and does not work for project API calls that update project settings. |
There was a problem hiding this comment.
In non-interactive mode, you can authenticate your users using two methods: email and password.
Let's remove the "your users" part because you're not really authenticating as a user. Also, what happened to the API key method?
While using an API key does not require an email and password to authenticate users
Don't mention users because the authentication is not as an end user.
and does not work for project API calls that update project settings.
you need to configure [...] and does not work [...] doesn't sound right.
|
|
||
| ## Email and password {% #email-and-password %} | ||
|
|
||
| Use `appwrite login` with your email, and password to log in so you can run tests or set up project-per-branch previews. |
There was a problem hiding this comment.
email, and password
is this comma supposed to be here?
to log in so you can run tests or set up project-per-branch previews.
Let's not mention this. Honestly, it's an unnecessary and confusing detail.
src/routes/docs/tooling/command-line/non-interactive/+page.markdoc
Outdated
Show resolved
Hide resolved
|
|
||
| # Authentication {% #authentication %} | ||
|
|
||
| In non-interactive mode, you can authenticate using two methods: email and password or API keys. While using an [API key](/docs/advanced/platform/api-keys) does not require an email and password to authenticate, the API key needs to have its [scopes](/docs/advanced/platform/api-keys#scopes) configured and the API key does not work for project API calls that update project settings. |
There was a problem hiding this comment.
Can we check this sentence with grammarly? Im not a native speaker and it reads hard.
|
|
||
| # Authentication {% #authentication %} | ||
|
|
||
| In non-interactive mode, you can authenticate using two methods: email and password or API keys. While using an [API key](/docs/advanced/platform/api-keys) does not require an email and password to authenticate, the API key needs to have its [scopes](/docs/advanced/platform/api-keys#scopes) configured and the API key does not work for project API calls that update project settings. |
There was a problem hiding this comment.
Regarding API key limitation, we can say that administrative operations cannot be done such as changing organization billing, deleting a project, or creating a new project. For those you must email&password login
…kdoc Co-authored-by: Matej Bačo <[email protected]>
… wording/flow. Update sentence to list specific operations API key does not work for.
What does this PR do?
Add two examples:
Test Plan
Tested login with non-interactive
Related PRs and Issues
X
Have you read the Contributing Guidelines on issues?
Yes