This is the documentation of the SUNFISH platform components available on ReadTheDocs
The documentation describes the key concepts of Federation-as-a-Service(FaaS) and SUNFISH Platform. FaaS is an innovative cloud federation solution enabled by the software SUNFISH Platform.
This documentation is in written in reStructuredText .rst files which are then automatically converted to HTML using Sphinx.
This GitHub repository contains all the .rst files. When a new commit is pushed to the repository, the updates are built and published on http://sunfish-platform-docs.rtfd.io/. Any new content that goes into docs/ triggers a new build and publication. The main entry-point is 'doc/index.rst'.
You can easily setup you local environment to contribute to the guide.
Here are the quick steps to setup Sphinx on your local machine. (You may need to adjust depending on your OS, check documentation)
sudo pip install Sphinx
sudo pip install sphinx_rtd_theme
sudo pip install sphinxcontrib-openapi
sudo pip install sphinxcontrib-swaggerdoc # for automatic inclusion of Swagger API
The commands 'make html' to locally compile the documentation in docs/_build/html/ where you can check from index.html a local version of the guide.
NB: the folder '_build' is not synchronised on the repository, it is local.
Configure the Git repository
- Clone this GitHub repository
git clone https://github.com/sunfish-prj/Platform-docs.git
Write your contributions
- Change the file in
docs(use this guide to help in writing Sphinx. Don't worry it is almost pure text) make htmlfromdocs/- Check locally your changes to the guide
docs/_build/html/
To include images in the guide
- Put the image to add, say Figure1.png, in
/docs/images/ - Insert in the text file the command
.. image:: images/Figure1.png
When ready to push the changes online
git add .git commit -m 'Your message'git push origin master- Check ReadTheDocs out!
If you prefer to use a GUI for Git, you might use https://desktop.github.com/