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: Adding minor edits to the Quick Start Guide #22500

Merged
merged 6 commits into from
Feb 2, 2022
15 changes: 9 additions & 6 deletions docs/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ This guide assumes you are using MacOS or a Linux machine and are an Automattici
### Using the installation script

To speed up the installation process, you may use our monorepo installation script. To do so:
- clone the Jetpack repo: `git clone https://github.com/Automattic/jetpack.git`
- clone the Jetpack repo using one of these two methods:
- A public SSH key ([recommended](https://github.com/Automattic/jetpack/blob/master/docs/development-environment.md#clone-the-repository)): `git clone git@github.com:Automattic/Jetpack.git`
- HTTPS: `git clone https://github.com/Automattic/jetpack.git`
- `cd` into the cloned `jetpack` folder.
- run `tools/install-monorepo.sh` from the monorepo root.
Once the installation is complete, continue onto the section [Running Jetpack locally](#running-jetpack-locally).
Expand All @@ -25,8 +27,9 @@ Prior to installation, we recommend using [`Homebrew`](https://brew.sh/) to mana

The Jetpack Monorepo requires the following to be installed on your machine:

- Start by cloning the GitHub repo:
- `git clone https://github.com/Automattic/jetpack.git`
- Start by cloning the GitHub repo using one of these two methods:
- A public SSH key ([recommended](https://github.com/Automattic/jetpack/blob/master/docs/development-environment.md#clone-the-repository)): `git clone git@github.com:Automattic/Jetpack.git`
- HTTPS: `git clone https://github.com/Automattic/jetpack.git`
- If you're not an Automattician, you can [fork the repo following the instructions here](https://docs.github.com/en/get-started/quickstart/contributing-to-projects).
- Bash (will need to be updated from default Mac version): `brew install bash`
- jq (JSON processor used in scripts): `brew install jq`
Expand All @@ -47,10 +50,10 @@ To setup Docker:
- Mac: `brew install --cask docker` (This will take a while!)
- Linux: `brew install docker`
- `open -a Docker` (or open the app from your Applications folder) to open the GUI application. You will likely need to enter your device password and accept their terms for a first time setup.
- Copy the settings file: `cp tools/docker/default.env tools/docker/.env`
- Copy the settings file from within the monorepo root: `cp tools/docker/default.env tools/docker/.env`
- Open `tools/docker/.env` and make any modifications you'd like.
- It's strongly recommend you at least change `WP_ADMIN_PASSWORD` to something more secure.
- Start the Docker container using `jetpack docker up` (this may take some time for the first setup)
- Start the Docker container using `jetpack docker up -d` (this may take some time for the first setup)
- Install WordPress in your Docker container using `jetpack docker install`
- Open up http://localhost to see your site!

Expand All @@ -62,7 +65,7 @@ In order to test features that require a WordPress.com connection and other netw

**Warning: This creates a tunnel to your local machine which should not be trusted as secure. If it is compromised, so is your computer and everything it has access to. Only `jetpack docker jt-up` when needed for testing things that require the site to be publicly accessible, and `jetpack docker jt-down` when completed.**

- Add a subdomain on [jurassic.tube](https://jurassic.tube/)
- Visit the [jurassic.tube](https://jurassic.tube/) homepage to create a subdomain
- Make sure you've run `pnpm install && pnpm cli-link`
- Make sure Docker is running `jetpack docker up -d`
- Stand on the monorepo root in your terminal and run `mkdir tools/docker/bin/jt`
Expand Down