Skip to content

Commit

Permalink
fix(ORG-45): Add blog link to readme and API docs
Browse files Browse the repository at this point in the history
Making it clear that breaking API and schema changes will be announced on the blog
  • Loading branch information
MonkeyDo committed Oct 7, 2020
1 parent 4694ac1 commit 217c611
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 1 deletion.
9 changes: 9 additions & 0 deletions README.md
Expand Up @@ -31,6 +31,15 @@ directories will exist:
* `static/js` - minified JavaScript files which are referred to by the site
pages.

## Contact and updates

Any questions? You can get in contact with the community on [our IRC channel](https://webchat.freenode.net/?channels=#bookbrainz) or [our forums](https://community.metabrainz.org/c/bookbrainz), or send us [an email](mailto:bookbrainz@metabrainz.org)

Breaking changes to the database schema or our API will be announced on
[our blog](https://blog.metabrainz.org/category/bookbrainz/), along with our other major updates,
so consider following that.


## Contributing
We welcome any and all contributions ! Whether you want to add or improve entries on [bookbrainz.org](https://bookbrainz.org), fix an issue on the website or provide new functionnality, we'll be happy to have your help and count you part of our ranks !
If you are new to open source contribution workflows, have a look at [this beginner's guide](https://akrabat.com/the-beginners-guide-to-contributing-to-a-github-project/) and our [contribution guidelines](CONTRIBUTING.md).
Expand Down
3 changes: 2 additions & 1 deletion src/api/swagger.js
Expand Up @@ -19,7 +19,8 @@ const swaggerOptions = {
name: 'BookBrainz',
url: 'https://bookbrainz.org/'
},
description: 'OpenAPI 3 documentation for the BookBrainz REST API. https://bookbrainz.org',
description: `OpenAPI 3 documentation for the BookBrainz REST API.<br/>
Breaking changes to the API will be announced <a href="https://blog.metabrainz.org/category/bookbrainz/" target="_blank">on our blog</a>.`,
title: 'BookBrainz API Documentation',
version: '0.2.0'
},
Expand Down

0 comments on commit 217c611

Please sign in to comment.