Skip to content

Commit

Permalink
readme: update doc for new lando (bug 1885346)
Browse files Browse the repository at this point in the history
Signed-off-by: Olivier Mehani <[email protected]>
  • Loading branch information
shtrom committed Oct 7, 2024
1 parent deb6244 commit bea6475
Showing 1 changed file with 19 additions and 19 deletions.
38 changes: 19 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ system, collectively known as "Conduit". This includes

* BMO, Mozilla's Bugzilla fork
* Phabricator, including extensions and patches
* Lando, both API and UI
* Lando
* Transplant, the service that lands commits
* A Mercurial server
* A container ("local-dev") with various command-line tools including MozPhab
Expand All @@ -27,7 +27,7 @@ substitute for self-contained tests in individual repositories.
1. You need to have [docker](https://docs.docker.com/install/) and
[docker-compose](https://docs.docker.com/compose/install/) installed.
1. For Lando, an Auth0 developer account. See the
[lando-ui README.md](https://github.com/mozilla-conduit/lando-ui/blob/master/README.md)
[lando README.md](https://github.com/mozilla-conduit/lando/blob/master/README.md)
for instructions on how to set that up.

### Steps
Expand All @@ -39,6 +39,8 @@ substitute for self-contained tests in individual repositories.
required for Lando and Transplant. If in doubt, please refer to the
relevant projects. Here is a sample file:

XXX This example is outdated

```
version: '3.4'
services:
Expand Down Expand Up @@ -80,7 +82,7 @@ services:
The "local-dev" container includes command-line tools used to interact
with Conduit services.

To set up the container run `docker-compose run local-dev`.
To set up the container run `docker-compose run --rm local-dev`.
You will be placed inside of a repository cloned from http://hg.test. You can
use it as a normal local development repository.

Expand Down Expand Up @@ -111,10 +113,11 @@ proxy, or run a preconfigured Firefox.

### Websites provided by the suite

* Phabricator - http://phabricator.test
* Lando - http://lando-ui.test
* Lando API - http://lando-api.test/ui via Swagger UI.
* Bugzilla - http://bmo.test
* Phabricator - http://phabricator.test
* Lando - http://lando.test
* (Legacy) Lando - http://lando-ui.test
* (Legacy) Lando API - http://lando-api.test/ui via Swagger UI.
* Mercurial - http://hg.test

## Running apps from local clone
Expand All @@ -134,11 +137,10 @@ repositories you wish to use locally to the `conduit` directory.
```shell
git clone [email protected]:mozilla-conduit/arcanist.git
git clone [email protected]:mozilla-bteam/bmo.git
git clone [email protected]:mozilla-conduit/lando-api.git
git clone [email protected]:mozilla-conduit/lando-ui.git
git clone [email protected]:mozilla-conduit/lando.git
git clone [email protected]:mozilla-conduit/phabricator.git
git clone [email protected]:mozilla-conduit/phabricator-emails.git
git clone [email protected]:mozilla-conduit/review.git
git clone [email protected]:mozilla-conduit/review.git # moz-phab
```

If you've installed all of the above projects, your directory structure
Expand All @@ -150,8 +152,7 @@ conduit
├── arcanist/
├── bmo/
├── suite/
├── lando-api/
├── lando-ui/
├── lando/
├── phabricator/
├── phabricator-emails/
└── review/
Expand Down Expand Up @@ -191,13 +192,12 @@ docker-compose \
up --build -d
```

And for example to work on lando-ui and lando-api,
And for example to work on lando,

```shell
docker-compose \
-f docker-compose.yml \
-f docker-compose.lando-api.yml \
-f docker-compose.lando-ui.yml \
-f docker-compose.lando.yml \
-f docker-compose.override.yml \
up --build -d
```
Expand All @@ -212,11 +212,10 @@ of the ARC wrapper "review" , load the `docker-compose.review.yml`.

If you don't want to spin up all configured containers, you can
specify the ones you'd like to work on. The command below runs
`phabricator.test`, `phabricator`, `phab.db`, `lando-api.test`,
`lando-api` and `lando-api.db` to allow the verification of the
`phabricator.test`, `phabricator`, `phab.db`, `lando.test`,
integration between Phabricator and Lando API:

`docker-compose up phabricator.test lando-api.test`
`docker-compose up phabricator.test lando.test`

## Preconfigured users:

Expand Down Expand Up @@ -295,16 +294,17 @@ Create a diff:
```shell
$ docker-compose run local-dev
# ./clone-repositories.sh
# cd repos
# cd test-repo
# echo test >> README
# hg commit -m "test info added"
# moz-phab install-certificate
# moz-phab submit -b 1
```

Log in to http://lando-ui.test.
Log in to http://lando.test.

Navigate to http://lando-ui.test/revisions/D2.
Navigate to http://lando.test/revisions/D2.

Confirm the warning and click on the `Land` button.

Expand Down

0 comments on commit bea6475

Please sign in to comment.