Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
+ Provide details on how to make a user an admin and access the admin dashboard.
+ Add info on feature flags and where they can be enabled disabled.
+ Clarify how to view builds of the documentation
  • Loading branch information
JakeHartnell committed Aug 18, 2015
1 parent 5938e48 commit 2e2386c
Show file tree
Hide file tree
Showing 6 changed files with 37 additions and 3 deletions.
4 changes: 2 additions & 2 deletions docs/INSTALL.rst
Original file line number Diff line number Diff line change
@@ -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
Expand Down
18 changes: 18 additions & 0 deletions docs/hacking/administration.rst
Original file line number Diff line number Diff line change
@@ -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 <config_uri> <username>

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.

8 changes: 8 additions & 0 deletions docs/hacking/documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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/

1 change: 1 addition & 0 deletions docs/hacking/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,4 @@ and how to contribute code or documentation to the project.
documentation
customized-embedding
ssl
administration
7 changes: 7 additions & 0 deletions docs/hacking/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ Contents:
.. toctree::
:maxdepth: 2

INSTALL
hacking/index
INSTALL
internals
api
CHANGES
Expand Down

0 comments on commit 2e2386c

Please sign in to comment.