diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 14ed3fb7..3d156711 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,5 +13,5 @@ Commit messages should start from an upper case. So `Change public ownership sou We are still in the process of moving from the Colouring Britain prototype to the Colouring Cities Core platform. If you notice any London-specific/Britain-specific text or variables in the Core code, we would be grateful if you could flag those up, either by raising an issue so that we can fix them or by fixing them yourself and creating a pull request. Ideally, any references to London should be replaced, either: -- with the City Name parameter (specified in [docs/configuring-colouring-cities](docs/configuring-colouring-cities.md)) when referring to a specific deployment. +- with the City Name parameter (specified in [the technical manual](https://github.com/colouring-cities/ccrp-technical-manual/wiki/Configuring-the-Colouring-Cities-Core-Platform)) when referring to a specific deployment. - with "Colouring Cities" when referring to the wider CCRP. diff --git a/README.md b/README.md index f6f65c43..a8455ec9 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ for download under a liberal open data license ## Setup and run #### Forking the Core Repository -If you are working with us as part of this GitHub organisation, then a repository and team may already have been set up for you. If you are already using the repository and want to add a new project, perhaps because you are expanding to additional cities, then please following these instructions to create a Fork of the core repository: [docs/working-with-colouring-core](docs/working-with-colouring-core.md). +If you are working with us as part of this GitHub organisation, then a repository and team may already have been set up for you. If you are already using the repository and want to add a new project, perhaps because you are expanding to additional cities, then please following these instructions to create a Fork of the core repository: [working-with-colouring-core](docs/working-with-colouring-core.md). #### Customise the Application: @@ -35,24 +35,24 @@ You can customise the Colouring Cities application by changing the values in the `app/src/cc-config.json` -For more information on the config system, see [docs/configuring-colouring-cities](docs/configuring-colouring-cities.md). +For more information on the config system, see [configuring-colouring-cities](https://github.com/colouring-cities/ccrp-technical-manual/wiki/Configuring-the-Colouring-Cities-Core-Platform). #### Test the application: -You can try out the Colouring Cities application by setting up your own development environment, which includes the option to load test data from OpenStreetMaps (OSM). See [docs/setup-dev-environment](docs/setup-dev-environment.md). +You can try out the Colouring Cities application by setting up your own development environment, which includes the option to load test data from OpenStreetMaps (OSM). See [setup-dev-environment](https://github.com/colouring-cities/ccrp-technical-manual/wiki/Setting-up-a-local-development-environment). _Last updated March 2022_ #### Create a production version of the application: -We also have documentation on setting up a production environment here: [docs/setup-production-environment](docs/setup-production-environment.md). +We also have documentation on setting up a production environment here: [setup-production-environment](https://github.com/colouring-cities/ccrp-technical-manual/wiki/Setting-Up-A-Production-Environment). _Last updated December 2021_ -**Note:** There are additional useful documentation within the `/docs` folder. +**Note:** There are additional useful documentation in the [CCRP Technical Manual](https://github.com/colouring-cities/ccrp-technical-manual/wiki). #### Troubleshooting -If you are having problems with the application, first look here: [docs/troubleshooting](docs/troubleshooting.md) to see if there is a solution for your problem. +If you are having problems with the application, first look here: [troubleshooting](docs/troubleshooting.md) to see if there is a solution for your problem. (Also, please consider updating this document if you encounter and problems and manage to solve them!) ## Acknowledgements