Merge pull request #33 from bbc/philipn-remove-jenkins-and-add-docs-link

Remove jenkins and add docs link
bbc · Nov 14, 2023 · fa0af62 · fa0af62
2 parents 8bca7c7 + 9e031b6
commit fa0af62
Show file tree

Hide file tree

Showing 3 changed files with 2 additions and 204 deletions.
diff --git a/Jenkinsfile b/Jenkinsfile
diff --git a/Jenkinsfile.json b/Jenkinsfile.json
diff --git a/README.md b/README.md
@@ -44,7 +44,7 @@ The API is well documented in the docstrings of the module mediajson, to view:
 ```bash
 make docs
 ```
-This command will render documentation as HTML in the `/docs` directory.
+This command will render documentation as HTML in the `/docs` directory. A rendered version of this documentation is available [here](https://bbc.github.io/rd-apmm-python-lib-mediajson/mediajson/mediajson.html).
 
 ## Development
 ### Commontooling
@@ -67,10 +67,7 @@ $ make test
 
 ### Continuous Integration
 
-This repository includes a Jenkinsfile which makes use of custom steps defined in a BBC internal
-library for use on our own Jenkins instances. As such it will not be immediately useable outside
-of a BBC environment, but may still serve as inspiration and an example of how to implement CI
-for this package.
+This repository includes [GitHub Actions workflows](./.github/workflows/) for CI. The shared workflows are centrally managed and should not be modified.
 
 ## Versioning