Improved grammar and fixed spelling and punctuation in the documentation. #374
Conversation
hassansuhaib
changed the title
hassansuhaib
changed the title
| * [`preevy init`](init.md) - Initialize or import a new profile | ||
| * [`preevy login`](login.md) - Login to the Livecycle SaaS | ||
| * [`preevy logs`](logs.md) - Show logs for an existing environment | ||
| * [`preevy ls`](ls.md) - List preview environments | ||
| * [`preevy profile`](profile.md) - View and update profile configuration | ||
| * [`preevy purge`](purge.md) - Delete all cloud provider machines, and potentially other resources | ||
| * [`preevy purge`](purge.md) - Delete all cloud provider machines and potentially other resources |
There was a problem hiding this comment.
CLI reference is auto-generated from the code - any changes will be reverted. You can make the change at the appropriate file in the commands dir
There was a problem hiding this comment.
I have now made the change in the appropriate file. I am leaving this here so that these docs remain updated.
| @@ -5,6 +5,6 @@ parent: /dashboard | |||
|
|
|||
| ## **Share code changes. Collect feedback.** | |||
|
|
|||
| Livecycle makes it easy to not only create previews of your latest changes, but also to share them and collect feedback in context. | |||
| Livecycle makes it easy to not only create previews of your latest changes but also to share them and collect feedback in context. | |||
There was a problem hiding this comment.
not sure removing the comma makes a better or more correct sentence
There was a problem hiding this comment.
This is correct according to Grammarly.
| @@ -75,7 +75,7 @@ BASE_URL=http://localhost:8030 docker compose -f docker-compose.yml -f docker-co | |||
|
|
|||
| ### 3. Expose the service's SSH endpoint | |||
|
|
|||
| Now we want to expose the tunnel service to the internet, so the machines running in the cloud could access it. In this example we'll be using [ngrok](https://ngrok.com/) to achieve that: | |||
| Now we want to expose the tunnel service to the internet, so the machines running in the cloud can access it. In this example, we'll be using [ngrok](https://ngrok.com/) to achieve that: | |||
There was a problem hiding this comment.
not sure removing the comma makes a better or more correct sentence
There was a problem hiding this comment.
No comma is removed; instead, one is added.
| @@ -7,7 +7,7 @@ title: Deploy to Google Cloud Platform | |||
|
|
|||
| Preevy can provision virtual machines on GCP using the `gce` driver. | |||
| Google compute engine provisioning time for a VM is usually less than a minute, the default machine size in use is e2-small (2GB, 2vCpu) which costs around $12 per month. | |||
| Google compute also offer $300 free credit for new users which is suited for trying out preevy. | |||
| Google Compute also offers a $300 free credit for new users which is suited for trying out preevy. | |||
There was a problem hiding this comment.
not sure "a" is correct here
There was a problem hiding this comment.
This is correct.
| @@ -51,7 +51,7 @@ Example AWS S3 URL: | |||
| s3://preevy-config/profile1?region=us-east-1 | |||
| ``` | |||
|
|
|||
| Refers to a profile stored on a S3 bucket named `preevy-config` in the region `us-east-1` under the base path `profile1`. | |||
| Refers to a profile stored on an S3 bucket named `preevy-config` in the region `us-east-1` under the base path `profile1`. | |||
There was a problem hiding this comment.
This is correct.
I used Grammarly. |
Co-authored-by: Roy Razon <[email protected]>
hassansuhaib
force-pushed
the
doc-improvement/grammar_punctuation_spelling
branch
from
1f18fda to
12513f3
Compare
This is a
By submitting this pull request I confirm I've read and complied with the below requirements 🖖