Adapt README.md to our instance
GitOrigin-RevId: f1c3f5a29664f23aaf2ae64b5fbac7bef4da9c34
diff --git a/README.md b/README.md
index e1459e9..622e290 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,10 @@
# Monorail Issue Tracker - bugs.avm99963.com
-This repo is a fork of the open-source Monorail issue tracker designed to run at bugs.avm99963.com. I've made the code public so it can inspire other developers to host relatively cheap Monorail instances.
+This repo is a fork of the open-source Monorail issue tracker designed to run at [bugs.avm99963.com](https://bugs.avm99963.com). I've made the code public so it can inspire other developers to host relatively cheap Monorail instances.
-The original README.md file is here below:
+Monorail development should generally be contributed [upstream](https://chromium.googlesource.com/infra/infra/+/main/appengine/monorail), this repo will only accept changes specific to small and relatively cheap instances.
+
+The original README.md file is here below (slightly modified where applicable):
---
@@ -32,16 +34,10 @@
1. Also follow https://cloud.google.com/appengine/docs/standard/python3/setting-up-environment to setup `gcloud`
1. Spin up dependent services.
1. We use docker and docker-compose to orchestrate. So install [docker](https://docs.docker.com/get-docker/) and [docker-compose](https://docs.docker.com/compose/install/) first. For glinux users see [go/docker](http://go/docker)
- 1. Make sure to authenticate with the App Engine SDK and configure Docker. This is needed to install Cloud Tasks Emulator.
- 1. `gcloud auth login`
- 1. `gcloud auth configure-docker`
- 1. If you get authentication errors here, run `setenv PATH = $PATH;/path/to/gcloud/bin`
1. Run `docker-compose -f dev-services.yml up -d`. This should spin up:
1. MySQL v5.6
1. Redis
1. Cloud Tasks Emulator
- 1. [TODO](https://github.com/aertje/cloud-tasks-emulator/issues/4) host this publicly and remove section.
- 1. This will require you to authenticate to Google Container Registry to pull the docker image: `gcloud auth login` `gcloud auth configure-docker`. If you're an open source developer and do not have access to the monorail project and thereby its container registry you will need to start the Cloud Tasks Emulator from [source](https://github.com/aertje/cloud-tasks-emulator)
1. Set up SQL database. (You can keep the same sharding options in settings.py that you have configured for production.).
1. Copy setup schema into the docker container
1. `docker cp schema/. mysql:/schema`