This repository was archived by the owner on Sep 29, 2023. It is now read-only.
feat: update cli docs #119
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@wess how much do you like this feature? 😅 |
|
@christyjacob4 please attach an up-to-date screenshot of the docs. |
brandonroberts
suggested changes
Feb 18, 2022
app/views/docs/command-line.phtml
Outdated
| </div> | ||
|
|
||
|
|
||
| <h3><a href="/docs/command-line#installWithScript" id="installWithScript">Install with script</a></h3> |
There was a problem hiding this comment.
Why have two options? Are developers going to choose to not use npm?
There was a problem hiding this comment.
So here was the thought process when we decided giving multiple installation options
- The previous version of the CLI was only distributed as a binary. So our install script was the only way for developers to install it. We didn't want to take away that option with the new release.
- While it might be safe to assume most developers have npm and node installed, we wanted to ensure our CLI can run without any dependencies.
Co-authored-by: Brandon <robertsbt@gmail.com>
Co-authored-by: Brandon <robertsbt@gmail.com>
Co-authored-by: Brandon <robertsbt@gmail.com>
Co-authored-by: Brandon <robertsbt@gmail.com>
Co-authored-by: Brandon <robertsbt@gmail.com>
Co-authored-by: Brandon <robertsbt@gmail.com>
Co-authored-by: Brandon <robertsbt@gmail.com>
Co-authored-by: Brandon <robertsbt@gmail.com>
Co-authored-by: Brandon <robertsbt@gmail.com>
Co-authored-by: Brandon <robertsbt@gmail.com>
Co-authored-by: Brandon <robertsbt@gmail.com>
Co-authored-by: Brandon <robertsbt@gmail.com>
|
@eldadfux here's the updated screenshot
|
|
Looks good, a few comments:
|
There was a problem hiding this comment.
- Agree with @eldadfux regarding
appwrite.json, may be we can provide a schema definition viaappwrite.id/appwrite_config_schemaor a better url ? - Why don't we have a install command to install Appwrite server? something like
- appwrite install (installs the latest version)
- appwrite install --version=0.10.1 (installs 0.10.1 version)
?
|
We could have the install command in the future, we wanted to keep it simpler for the 1st release. |
eldadfux
approved these changes
Feb 21, 2022
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.