From 6ede9e3ec74e89dc61b48c52b439a6581dfde80e Mon Sep 17 00:00:00 2001 From: Harry Wood Date: Sat, 12 Feb 2022 17:53:39 +0000 Subject: [PATCH 1/2] Fix contrib doc to remove reference to travis Remove the reference to Travis CI. Our CI pipeline now runs withing github actions. --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 474c80b4f..61e23f810 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -38,8 +38,8 @@ bundle exec rails test:all You can view test coverage statistics by browsing the `coverage` directory. -The tests are automatically run on Pull Requests and other commits with the -results shown on [Travis CI](https://travis-ci.org/openstreetmap/openstreetmap-website). +The tests are automatically run on Pull Requests and other commits via github +actions. The results shown are within the PR display on github. ## Static Analysis From 1714e2f02dac45b87d35cecc0633379e70e38fbb Mon Sep 17 00:00:00 2001 From: Harry Wood Date: Sat, 12 Feb 2022 17:58:43 +0000 Subject: [PATCH 2/2] Remove section on removed rake doc:app Remove the section of contributing docs about how `rake doc:app` can be used to generate some sort of documentation. That will not work any more, since this task was removed from Rails v5 because people don't generally use it! https://stackoverflow.com/a/36804474/338265 --- CONTRIBUTING.md | 8 -------- 1 file changed, 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 61e23f810..aaa1b5d4b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -79,14 +79,6 @@ database, and update the list of available keys manually. Adding or removing keys to this list is therefore discouraged, but contributions to the descriptive texts are welcome. -## Code Documentation - -To generate the HTML documentation of the API/rails code, run the command - -``` -rake doc:app -``` - ## Committing When you submit patches, the project maintainer has to read them and