Skip to content

Commit

Permalink
Improves parameter deciption
Browse files Browse the repository at this point in the history
  • Loading branch information
gfiorav committed Aug 17, 2015
1 parent c6944c9 commit 7806011
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 20 deletions.
28 changes: 14 additions & 14 deletions doc/manual/source/operations/change_feature_flags.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Enabling a feature for all users

Enabling a feature for all users is done with a rake task called ``enable_feature_for_all_users`` and it takes one parameter.

* **Feature name** is the name of the feature flag to be enabled. For example: 'special_dashboard'.
* **Feature name <feature name>** is the name of the feature flag to be enabled. For example: 'special_dashboard'.

This task is executed like:

Expand All @@ -25,8 +25,8 @@ Enabling a feature for a given user

Enabling a feature for a given user is done with a rake task called ``enable_feature_for_user`` and it takes two parameters.

* **Feature name** is the name of the feature flag to be enabled. For example: 'special_dashboard'.
* **User's user name** is the user name of the user to whom the feature flag is to be enabled. For example: 'manolo'.
* **Feature name <feature name>** is the name of the feature flag to be enabled. For example: 'special_dashboard'.
* **User's user name <user name>** is the user name of the user to whom the feature flag is to be enabled. For example: 'manolo'.

This task is executed like:

Expand All @@ -42,10 +42,10 @@ And an example to enable the 'special_dashboard' feature for user with user name
Enabling a feature for a given organization
-------------------------------------------

Enabling a feature for a given organization is done with a rake task called ``enable_feature_for_organization`` and it takes two parameters.
Enabling a feature for a given organization is done with a rake task called `enable_feature_for_organization`` and it takes two parameters.

* **Feature name** is the name of the feature flag to be enabled. For example: 'special_dashboard'.
* **Organization name** is the internal name ('cartodb' vs 'CartoDB Inc.') to which the feature flag is to be enabled. For example: 'cartodb'.
* **Feature name <feature name>** is the name of the feature flag to be enabled. For example: 'special_dashboard'.
* **Organization name <organization name>** is the internal name ('cartodb' vs 'CartoDB Inc.') to which the feature flag is to be enabled. For example: 'cartodb'.

This task is executed like:

Expand All @@ -63,7 +63,7 @@ Disabling a feature for all users

Disabling a feature for all users is done with a rake task called ``disable_feature_for_all_users`` and it takes one parameter.

* **Feature name** is the name of the feature flag to be disabled. For example: 'special_dashboard'.
* **Feature name <feature name>** is the name of the feature flag to be disabled. For example: 'special_dashboard'.

This task is executed like:

Expand All @@ -79,8 +79,8 @@ Disabling a feature for a given user

Disabling a feature for a given user is done with a rake task called ``disable_feature_for_user`` and it takes two parameters.

* **Feature name** is the name of the feature flag to be disabled. For example: 'special_dashboard'.
* **User's user name** is the user name of the user to whom the feature flag is to be disabled. For example: 'manolo'.
* **Feature name <feature name>** is the name of the feature flag to be disabled. For example: 'special_dashboard'.
* **User's user name <user name>** is the user name of the user to whom the feature flag is to be disabled. For example: 'manolo'.

This task is executed like:

Expand All @@ -96,10 +96,10 @@ And an example to disable the 'special_dashboard' feature for user with user nam
Disabling a feature for a given organization
--------------------------------------------

Disabling a feature for a given organization is done with a rake task called ``disable_feature_for_organization`` and it takes two parameters.
Disabling a feature for a given organization is done with a rake task called `disable_feature_for_organization`` and it takes two parameters.

* **Feature name** is the name of the feature flag to be disabled. For example: 'special_dashboard'.
* **Organization name** is the internal name ('cartodb' vs 'CartoDB Inc.') to which the feature flag is to be disabled. For example: 'cartodb'.
* **Feature name <feature name>** is the name of the feature flag to be disabled. For example: 'special_dashboard'.
* **Organization name <organization name>** is the internal name ('cartodb' vs 'CartoDB Inc.') to which the feature flag is to be disabled. For example: 'cartodb'.

This task is executed like:

Expand All @@ -117,7 +117,7 @@ Adding a feature flag

Adding feature flags should be done using the rake task called ``add_feature flag``. This rake task only takes one argument:

* **Feature name** is the name of the feature flag to be created.
* **Feature name <feature name>** is the name of the feature flag to be created.

This task is executed like:

Expand All @@ -133,7 +133,7 @@ Removing a feature flag

Removing feature flags should be done using the rake task called ``remove_feature flag``. This rake task only takes one argument:

* **Feature name** is the name of the feature flag to be removed.
* **Feature name <feature name>** is the name of the feature flag to be removed.

This task is executed like:

Expand Down
17 changes: 11 additions & 6 deletions doc/manual/source/operations/create_orgs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,17 @@ 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 <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'.

Taking into account the previous information, creating an organization owned by 'manolo', named 'CartoDB Inc.', referred to as 'cartodb', with 5 seats and a 1GB quota, is just running the following command:
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>"``


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:

``bundle exec rake cartodb:db:create_new_organization_with_owner ORGANIZATION_NAME="cartodb" ORGANIZATION_DISPLAY_NAME="CartoDB Inc." ORGANIZATION_SEATS="5" ORGANIZATION_QUOTA="1073741824" USERNAME="manolo"``

0 comments on commit 7806011

Please sign in to comment.