diff --git a/docs/INSTALL.rst b/docs/INSTALL.rst index 90a68d57893..6a7e19ab76d 100644 --- a/docs/INSTALL.rst +++ b/docs/INSTALL.rst @@ -1,5 +1,5 @@ -Installation guide -################## +Deploying to a production environment +##################################### This document contains instructions for deploying h to a production environment. If you are looking for instructions on setting up a development environment for diff --git a/docs/hacking/administration.rst b/docs/hacking/administration.rst new file mode 100644 index 00000000000..b3abc9f9d5c --- /dev/null +++ b/docs/hacking/administration.rst @@ -0,0 +1,18 @@ +Administration +-------------- + +To access the admin interface, a user must be logged into hypothes.is and have admin permissions. +To grant admin permissions to a user, run the following command in the virtual environment: + + .. code-block:: bash + + hypothesis admin + +For example, to make someone an admin in the development configuration: + + .. code-block:: bash + + hypothesis admin conf/development.ini usernamehere + +When this user signs in they can now access the adminstration panel at ``/admin``. The administration panel has basic options for managing users, as well as the ability to enable feature flags to try out features currently in development. + diff --git a/docs/hacking/documentation.rst b/docs/hacking/documentation.rst index 97b35a12c3b..824976fa7b8 100644 --- a/docs/hacking/documentation.rst +++ b/docs/hacking/documentation.rst @@ -7,5 +7,13 @@ To build the documentation, ensure that Sphinx_ is installed and issue the $ cd docs/ $ make html +When the build finishes, you can view the documentation by running a static +web server in the newly generated ``_build/html/`` directory. For example, you +can install the node http-server and run it like so:: + + $ npm install http-server -g + $ cd _build/html + $ http-server + .. _Sphinx: http://sphinx-doc.org/ diff --git a/docs/hacking/index.rst b/docs/hacking/index.rst index 06df99a4673..d2a1e3b74cd 100644 --- a/docs/hacking/index.rst +++ b/docs/hacking/index.rst @@ -17,3 +17,4 @@ and how to contribute code or documentation to the project. documentation customized-embedding ssl + administration diff --git a/docs/hacking/install.rst b/docs/hacking/install.rst index 045e27b6ad9..9d998e36378 100644 --- a/docs/hacking/install.rst +++ b/docs/hacking/install.rst @@ -289,3 +289,10 @@ use and configure it. .. _pyramid_debugtoolbar: https://github.com/Pylons/pyramid_debugtoolbar .. _pyramid_debugtoolbar documentation: http://docs.pylonsproject.org/projects/pyramid-debugtoolbar/en/latest/ + +Feature Flags +------------- + +Features flags allow admins to enable or disable features for certain groups of +users. You can enable or disable them from the administration dashboard. Please consult the :doc:`administration` documentation for more information on accessing the admin dashboard. + diff --git a/docs/index.rst b/docs/index.rst index e2b717b2acd..d648899f114 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,8 +6,8 @@ Contents: .. toctree:: :maxdepth: 2 - INSTALL hacking/index + INSTALL internals api CHANGES