1208115 - Add Nucleus info for release notes to bedrock documentation

Status: NEW

(www.mozilla.org :: Bedrock, enhancement)

Description

[Malena Andrade [:malenita]]

Add Nucleus API information for release notes to bedrock documentation.

Information below was gathered from chat on IRC. Needs to be reviewed.

Nucleus API
http://nucleus.readthedocs.org/en/latest/

Note Instance
https://nucleus.mozilla.org/rna/notes/1/

Release Instance
https://nucleus.mozilla.org/rna/releases/1/

Models
https://github.com/mozilla/rna/blob/master/rna/models.py

There are some methods there that are also available on the note and release instances in the template that don't show up as API fields. Model instances are what is seen in the templates. The API is mainly used for data replication and by JS.

Custom enhancements to django admin
https://github.com/mozilla/rna/blob/master/rna/static/jsx/releasenotes.js

Those are in a separate repo instead of bedrock directly, the reason for which is both bedrock and nucleus have that as a dependency.


Views that select the templates and populate the context
https://github.com/mozilla/bedrock/blob/master/bedrock/releasenotes/views.py