Skip to content

Commit

Permalink
Merge pull request #1330 from Scifabric/docs-pybossa
Browse files Browse the repository at this point in the history
Fixes.
  • Loading branch information
teleyinex committed Dec 15, 2016
2 parents 0dd173e + dfb5ca6 commit ed37e67
Show file tree
Hide file tree
Showing 26 changed files with 358 additions and 358 deletions.
14 changes: 7 additions & 7 deletions doc/admin.rst
@@ -1,9 +1,9 @@
======================
Administrating PyBossa
Administrating PYBOSSA
======================

PyBossa has three type of users: anonymous, authenticated and administrators.
By default the first created user in a PyBossa server will become an
PYBOSSA has three type of users: anonymous, authenticated and administrators.
By default the first created user in a PYBOSSA server will become an
administrator and manage the site with full privileges.

And admin user will be able to access the admin page by clicking in the user
Expand All @@ -29,7 +29,7 @@ Administrators can manage different areas of the server:

.. note::
In the users option, admins will be able
to obtain a list of all registered users in the PyBossa system, in either
to obtain a list of all registered users in the PYBOSSA system, in either
json or csv formats.

.. note::
Expand All @@ -56,12 +56,12 @@ You will see a "Add to Featured" link to add a a project to featured front page
Categories
==========

PyBossa provides by default two type of categories:
PYBOSSA provides by default two type of categories:

1. **Thinking**: for projects where the users can use their skills to solve
a problem (i.e. image or sound pattern recognition).
2. **Sensing**: for projects where the users can help gathering data using
tools like EpiCollect_ and then analyze the data in the PyBossa server.
tools like EpiCollect_ and then analyze the data in the PYBOSSA server.

Admins can add as many categories as they want, just type then and its
description and click in the green button labeled: Add category.
Expand Down Expand Up @@ -120,7 +120,7 @@ The section will let you know the following information:
Dashboard
=========

The dashboard allows you to see what's going on in your PyBossa server.
The dashboard allows you to see what's going on in your PYBOSSA server.

.. image:: http://i.imgur.com/TmB0dx2.png

Expand Down
8 changes: 4 additions & 4 deletions doc/api.rst
Expand Up @@ -86,7 +86,7 @@ Task Runs will have only two parents: the associated task and associated project
Rate Limiting
-------------

Rate Limiting has been enabled for all the API endpoints (since PyBossa v2.0.1).
Rate Limiting has been enabled for all the API endpoints (since PYBOSSA v2.0.1).
The rate limiting gives any user, using the IP, **a window of 15 minutes to do at
most 300 requests per endpoint**.

Expand All @@ -98,7 +98,7 @@ requests without problems:
* **X-RateLimit-Reset**: the remaining window before the rate limit resets in UTC epoch seconds

We recommend to use the Python package **requests** for interacting with
PyBossa, as it is really simple to check those values:
PYBOSSA, as it is really simple to check those values:

.. code-block:: python
Expand Down Expand Up @@ -180,7 +180,7 @@ Finally, you can get a list of users by doing::
creation date will be visible for everyone through the API.

.. note::
By default PyBossa limits the list of items to 20. If you want to get more
By default PYBOSSA limits the list of items to 20. If you want to get more
items, use the keyword **limit=N** with **N** being a number to get that
amount. There is a maximum of 100 to the **limit** keyword, so if you try to
get more items at once it won't work.
Expand Down Expand Up @@ -394,7 +394,7 @@ Requesting the user's oAuth tokens
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

A user who has registered or signed in with any of the third parties supported
by PyBossa (currently Twitter, Facebook and Google) can request his own oAuth
by PYBOSSA (currently Twitter, Facebook and Google) can request his own oAuth
tokens by doing::

GET http://{pybossa-site-url}/api/token?api_key=API-KEY
Expand Down
4 changes: 2 additions & 2 deletions doc/build_with_pybossa.rst
@@ -1,8 +1,8 @@
==================
Build with PyBossa
Build with PYBOSSA
==================

This section covers how to you can write and manage your own PyBossa
This section covers how to you can write and manage your own PYBOSSA
project.

We suggest starting by taking a quick look at the :doc:`overview` as this will
Expand Down
10 changes: 5 additions & 5 deletions doc/changelog/v0.2.3.rst
Expand Up @@ -5,7 +5,7 @@ Changelog v0.2.3
The most interesting changes are the following:
* New security version for POSTing task_runs preventing abusing the system
* CKAN backend performance improvements: polling now with JavaScript
* Themes support: now you can easily customize PyBossa look and feel
* Themes support: now you can easily customize PYBOSSA look and feel
* Breadth First Scheduler improved: now users can only participate once in
every task.
* Refactor API and add three new endpoints: globalstats, user and token.
Expand All @@ -25,7 +25,7 @@ The most interesting changes are the following:
* Background jobs dashboard: admins can manage background jobs with a dashboard.
* Audit log for projects: admin users can see the changes that a project has
gone through.
* Newsletters: a PyBossa project can now show a newsletter subscription page
* Newsletters: a PYBOSSA project can now show a newsletter subscription page
to a Mailchimp list.
* Export tasks and taskruns changes: creation of CSV and JSON files for both
task and task runs are now handled in the background regularly, and served
Expand All @@ -36,15 +36,15 @@ The most interesting changes are the following:
* Apps are now projects: URL for projects have been renamed from /app/aproject to
/project/aproject in all the code, both front-end and back-end, including
database and API.
* Plugins system: support for creating custom plugins and add them to a PyBossa
* Plugins system: support for creating custom plugins and add them to a PYBOSSA
server has been added.
* PyBossa dashboard: see what's going on in your server. **REQUIRES POSTGRESQL >= 9.3**
* PYBOSSA dashboard: see what's going on in your server. **REQUIRES POSTGRESQL >= 9.3**
* Add keyset pagination for the API: this returns results much faster than
offsets.

For a full list of changes, see associated `Github milestone`_.

.. _Github milestone: https://github.com/PyBossa/pybossa/issues?milestone=7&page=1&state=closed
.. _Github milestone: https://github.com/Scifabric/pybossa/issues?milestone=7&page=1&state=closed

Upgrading
=========
Expand Down
6 changes: 3 additions & 3 deletions doc/changelog/v1.1.3.rst
Expand Up @@ -6,12 +6,12 @@ Changelog v1.1.3
was delivered to the volunteer so project owners can keep track of the time
invested by the volunteer in completing the task.
* Fix issue with completed projects being listed as inactive in a background
job (https://github.com/PyBossa/pybossa/issues/1214).
* Fix issue with SQL query for quarterly jobs (https://github.com/PyBossa/pybossa/issues/1206).
job (https://github.com/Scifabric/pybossa/issues/1214).
* Fix issue with SQL query for quarterly jobs (https://github.com/Scifabric/pybossa/issues/1206).
* Upgraded dependencies.
* Fix bug that was preventing saving the description of a project if it was
provided on project creation, generating always the description by cropping
the long description (https://github.com/PyBossa/pybossa/pull/1213).
the long description (https://github.com/Scifabric/pybossa/pull/1213).


Upgrading
Expand Down
4 changes: 2 additions & 2 deletions doc/changelog/v1.2.1.rst
Expand Up @@ -2,7 +2,7 @@
Changelog v1.2.1
================

* Get latest news about PyBossa and SciFabric for admins. The admin page will
feature the latest releases of PyBossa and news about SciFabric. You can customize
* Get latest news about PYBOSSA and SciFabric for admins. The admin page will
feature the latest releases of PYBOSSA and news about SciFabric. You can customize
more news sites if you want.

2 changes: 1 addition & 1 deletion doc/changelog/v1.6.1.rst
Expand Up @@ -2,5 +2,5 @@
Changelog v1.6.1
================

* PyBossa security improvement for tasks and task runs.
* PYBOSSA security improvement for tasks and task runs.

2 changes: 1 addition & 1 deletion doc/changelog/v1.6.2.rst
Expand Up @@ -2,5 +2,5 @@
Changelog v1.6.2
================

* PyBossa supports webassets: SASS, LESS, Coffee Script, etc.
* PYBOSSA supports webassets: SASS, LESS, Coffee Script, etc.

6 changes: 3 additions & 3 deletions doc/contributing.rst
@@ -1,11 +1,11 @@
Contributing to the PyBossa development
Contributing to the PYBOSSA development
=======================================
Thus you have decided that this project is interesting and you want to help us: **THANKS!**

If you want to help us you can do it by:

* Proposing new features in the `Issues page <https://github.com/PyBossa/pybossa/issues>`_,
* Submitting new bugs/issues in the `Issues page <https://github.com/PyBossa/pybossa/issues>`_, or
* Proposing new features in the `Issues page <https://github.com/Scifabric/pybossa/issues>`_,
* Submitting new bugs/issues in the `Issues page <https://github.com/Scifabric/pybossa/issues>`_, or
* Fixing bugs and sending us actual code patches.

The project is using the popular `Github Workflow
Expand Down

0 comments on commit ed37e67

Please sign in to comment.