From 2b2d1ca017d2fd02867f301767eab5a1d380b0dd Mon Sep 17 00:00:00 2001 From: Guido Fioravantti Date: Mon, 17 Aug 2015 16:03:31 +0200 Subject: [PATCH] Improves parameter depiction --- doc/manual/source/operations/create_orgs.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/manual/source/operations/create_orgs.rst b/doc/manual/source/operations/create_orgs.rst index 94d4bbfd50f3..636823cb6394 100644 --- a/doc/manual/source/operations/create_orgs.rst +++ b/doc/manual/source/operations/create_orgs.rst @@ -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 ** 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. -* **Owner's user name ** 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_DISPLAY_NAME="" ORGANIZATION_SEATS="" ORGANIZATION_QUOTA="" USERNAME=""`` +``bundle exec rake cartodb:db:create_new_organization_with_owner ORGANIZATION_NAME="" ORGANIZATION_DISPLAY_NAME="" ORGANIZATION_SEATS="" ORGANIZATION_QUOTA="" 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: