mirror of https://github.com/bigchaindb/bigchaindb.git synced 2024-10-13 13:34:05 +00:00

History

Krish 425397f644 NGINX frontend for MongoDB and BigchainDB (#1304 )

- Added NGINX deployment to frontend both BDB and MDB.
- Nginx is configured with a whitelist (which is read from a ConfigMap)
to allow only other MDB nodes in the closter to communicate with it.
- Azure LB apparently does not support proxy protocol and hence
whitelisting fails as nginx always observer the LB IP instead of the
real IP in the TCP stream.
- Whitelisting source IPs for MongoDB
- Removing deprecated folder
- Better log format
- Intuitive port number usage
- README and examples
- Addressed a typo in PYTHON_STYLE_GUIDE.md
- Azure LB apparently does not support proxy protocol and hence
whitelisting fails as nginx always observer the LB IP instead of the
real IP in the TCP stream.
- Whitelisting source IPs for MongoDB
- Removing deprecated folder
- Multiple changes:
- Better log format
- Intuitive port number usage
- README and examples
- Addressed a typo in PYTHON_STYLE_GUIDE.md
- Documentation
- add the k8s directory to the ignore list in codecov.yml

2017-03-22 14:25:25 +01:00

root

Merge pull request #1300 from bigchaindb/update-copyright-year-in-docs

2017-03-20 09:38:24 +01:00

server

NGINX frontend for MongoDB and BigchainDB (#1304 )

2017-03-22 14:25:25 +01:00

README.md

Updated docs/README.md

2016-10-27 14:09:55 +02:00

README.md

Documentation on ReadTheDocs

The BigchainDB Documentation Strategy

Include explanatory comments and docstrings in your code. Write Google style docstrings with a maximum line width of 119 characters.
For quick overview and help documents, feel free to create README.md or other X.md files, written using GitHub-flavored Markdown. Markdown files render nicely on GitHub. We might auto-convert some .md files into a format that can be included in the long-form documentation.
We use Sphinx to generate the long-form documentation in various formats (e.g. HTML, PDF).
We also use Sphinx to generate Python code documentation (from docstrings and possibly other sources).
We also use Sphinx to document all REST APIs, with the help of the httpdomain extension.

How to Generate the HTML Version of the Long-Form Documentation

If you want to generate the HTML version of the long-form documentation on your local machine, you need to have Sphinx and some Sphinx-contrib packages installed. To do that, go to a subdirectory of docs (e.g. docs/server) and do:

pip install -r requirements.txt

You can then generate the HTML documentation in that subdirectory by doing:

make html

It should tell you where the generated documentation (HTML files) can be found. You can view it in your web browser.