Skip to content

Commit

Permalink
Improves parameter depiction
Browse files Browse the repository at this point in the history
  • Loading branch information
gfiorav committed Aug 17, 2015
1 parent 7806011 commit 2b2d1ca
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions doc/manual/source/operations/create_orgs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ To create a new organization, a rake task called ``create_new_organization_with_

In order to create the organization, 4 parameters must be set:

* **Organization name <ORGANIZATION_NAME>** is a short nickname for the organization, that may only contain letters, numbers and dash (-) characters. For example, 'cartodb' would be OK.
* **Organization display name <ORGANIZATION_DISPLAY_NAME>** is a longer, more beautiful name for the organization. It may contain any characters needed. For example, 'CartoDB Inc.'.
* **Organization seats <ORGANIZATION_SEATS>** is the number of users that will be able to be created under the organization. For example, 5 seats will mean that a maximum of 5 users can belong to the organization.
* **Organization quota <ORGANIZATION_QUOTA>** is the space quota in **bytes** that the organization is assigned. For example, 1024 * 1024 * 1024 is 1GB of quota.
* **Owner's user name <USERNAME>** is the user name of the owner of the organization. In our example, let's assume that our user name is 'manolo'.
* ``ORGANIZATION_NAME`` is a short nickname for the organization, that may only contain letters, numbers and dash (-) characters. For example, 'cartodb' would be OK.
* ``ORGANIZATION_DISPLAY_NAME`` is a longer, more beautiful name for the organization. It may contain any characters needed. For example, 'CartoDB Inc.'.
* ``ORGANIZATION_SEATS`` is the number of users that will be able to be created under the organization. For example, 5 seats will mean that a maximum of 5 users can belong to the organization.
* ``ORGANIZATION_QUOTA`` is the space quota in **bytes** that the organization is assigned. For example, 1024 * 1024 * 1024 is 1GB of quota.
* ``USERNAME`` is the user name of the owner of the organization. In our example, let's assume that our user name is 'manolo'.

This task is executed like:

``bundle exec rake cartodb:db:create_new_organization_with_owner ORGANIZATION_NAME="<ORGANIZATION_NAME>" ORGANIZATION_DISPLAY_NAME="<ORGANIZATION_DISPLAY_NAME>" ORGANIZATION_SEATS="<ORGANIZATION_SEATS>" ORGANIZATION_QUOTA="<ORGANIZATION_QUOTA>" USERNAME="<USERNAME>"``
``bundle exec rake cartodb:db:create_new_organization_with_owner ORGANIZATION_NAME="<org_name>" ORGANIZATION_DISPLAY_NAME="<org_display_name>" ORGANIZATION_SEATS="<org_seats>" ORGANIZATION_QUOTA="<org_quota>" USERNAME="<username>"``


and an example execution for creating an organization owned by 'manolo', named 'CartoDB Inc.', referred to as 'cartodb', with 5 seats and a 1GB quota, would be:
Expand Down

0 comments on commit 2b2d1ca

Please sign in to comment.