Fixed links + search

Author: pdube

source/includes/_administration.md

@@ -1,4 +1,4 @@
-# Administration API
+# Administration
 
 The following sections describe the various endpoints exposed by CloudMC to manage customer's configuration and interact with various core functionality of the system. Using these, you can automate various workflows without having to log into the portal, or simply integrate different aspects of CloudMC with your own toolchain.
 <aside class="notice">

source/includes/_cloudstack.md

@@ -1,10 +1,8 @@
-# CloudStack API
+# CloudStack plugin
 
-The CloudStack API provides endpoints for carrying out operations on CloudMC compute and networking entities. While each operation has its own validation and required fields, all operations need to specify the service code and environment in which they should be carried out. The following example URL describes how to specify this information for all entities.
+The CloudStack plugin provides endpoints for carrying out operations on CloudMC compute and networking entities. While each operation has its own validation and required fields, all operations need to specify the service code and environment in which they should be carried out. The following example URL describes how to specify this information for all entities.
 
-<code>https://cloudmc_endpoint/v1/services/<a href="#service-connections">:service_code</a>/<a href="#environments">:environment_name</a>/:entity_type</code>
-
-The two CloudStack service codes currently available in CloudMC correspond to compute regions: `compute-qc` for Québec, and `compute-on` for Ontario.
+<code>https://cloudmc_endpoint/v1/services/<a href="#administration-service-connections">:service_code</a>/<a href="#administration-environments">:environment_name</a>/:entity_type</code>
 
 <aside class="notice">
 An easy way to remember the structure of API endpoints is that going from left to right, the scope gets progressively more specific. First service, then environment of that service, then entity type, then operation on that entity type, etc.

source/includes/_getting_started.md

@@ -79,8 +79,8 @@ When an API request is successful, the response body will contain the `data` fie
 Attributes |  
 --- | ---
 `data` | The data field contains the object requested by the API caller
-`taskId` | The [task id](#tasks) of an operation executed through the [compute API](#compute-api)
-`taskStatus` | The status of a [task](#tasks) of an operation executed through the [compute API](#compute-api)
+`taskId` | The [task id](#tasks) of an operation executed through the services API
+`taskStatus` | The status of a [task](#tasks) of an operation executed the services API
 <!--
 `metadata` | The metadata is an optionally returned field containing paging and sorting information
 -->

source/includes/_openstack.md

@@ -1,3 +1,3 @@
-# OpenStack Plugin
+# OpenStack plugin
 
 The CloudMC OpenStack plugin incorporates various OpenStack services such as Nova and Neutron into CloudMC's API. It also enforces CloudMC's environment-centric multi-tenancy model and RBAC over top of OpenStack.

source/includes/administration/_environments.md

@@ -1,6 +1,6 @@
 ## Environments
 
-Environments allow you to manage resources of a specific service and to manage your [users'](#users) access to them. With [environment roles](#roles), you have tight control of what a user is allowed to do in your environment. A general use case of environments is to split your resources into different [deployment environments](https://en.wikipedia.org/wiki/Deployment_environment) (e.g. dev, staging and production). The advantage is that resources of different deployments are isolated from each other and you can restrict user access to your most critical resources.
+Environments allow you to manage resources of a specific service and to manage your [users'](#administration-users) access to them. With [environment roles](#administration-roles), you have tight control of what a user is allowed to do in your environment. A general use case of environments is to split your resources into different [deployment environments](https://en.wikipedia.org/wiki/Deployment_environment) (e.g. dev, staging and production). The advantage is that resources of different deployments are isolated from each other and you can restrict user access to your most critical resources.
 
 
 <!-------------------- LIST ENVIRONMENTS -------------------->
@@ -55,9 +55,9 @@ Attributes | &nbsp;
 `description`<br/>*string* | The description of the environment
 `membership`<br/>*string* | Type of membership of the environment. (e.g. ALL_ORG_USERS, MANY_USERS)
 `creationDate`<br/>*long* | The date in [unix time](https://en.wikipedia.org/wiki/Unix_time) that the environment was created
-`organization`<br/>*[Organization](#organizations)* | The organization of the environment<br/>*includes*: `id`, `name`, `entryPoint`
-`serviceConnection`<br/>*[ServiceConnection](#service-connections)* | The service connection of the environment<br/>*includes*: `id`, `name`
-`roles`<br/>*Array[[Role](#roles)]* | The roles of the environment with all the users assigned to them.<br/>*includes*: `id`, `name`, `isDefault`, `users.id`, `users.name`
+`organization`<br/>*[Organization](#administration-organizations)* | The organization of the environment<br/>*includes*: `id`, `name`, `entryPoint`
+`serviceConnection`<br/>*[ServiceConnection](#administration-service-connections)* | The service connection of the environment<br/>*includes*: `id`, `name`
+`roles`<br/>*Array[[Role](#administration-roles)]* | The roles of the environment with all the users assigned to them.<br/>*includes*: `id`, `name`, `isDefault`, `users.id`, `users.name`
 
 
 
@@ -118,10 +118,10 @@ Attributes | &nbsp;
 `description`<br/>*string* | The description of the environment
 `membership`<br/>*string* | Type of membership of the environment. (e.g. ALL_ORG_USERS, MANY_USERS)
 `creationDate`<br/>*long* | The date in [unix time](https://en.wikipedia.org/wiki/Unix_time) that the environment was created
-`organization`<br/>*[Organization](#organizations)* | The organization of the environment<br/>*includes*: `id`, `name`, `entryPoint`
-`serviceConnection`<br/>*[ServiceConnection](#service-connections)* | The service connection of the environment<br/>*includes*: `id`, `name`
-`users`<br/>*Array[[User](#users)]* | The users that are members of the environment<br/>*includes*: `id`, `username`
-`roles`<br/>*Array[[Role](#roles)]* | The roles of the environment with all the users assigned to them.<br/>*includes*: `id`, `name`, `isDefault`, `users.id`, `users.name`
+`organization`<br/>*[Organization](#administration-organizations)* | The organization of the environment<br/>*includes*: `id`, `name`, `entryPoint`
+`serviceConnection`<br/>*[ServiceConnection](#administration-service-connections)* | The service connection of the environment<br/>*includes*: `id`, `name`
+`users`<br/>*Array[[User](#administration-users)]* | The users that are members of the environment<br/>*includes*: `id`, `username`
+`roles`<br/>*Array[[Role](#administration-roles)]* | The roles of the environment with all the users assigned to them.<br/>*includes*: `id`, `name`, `isDefault`, `users.id`, `users.name`
 
 <!-------------------- CREATE ENVIRONMENT -------------------->
 
@@ -167,18 +167,16 @@ Required | &nbsp;
 -------- | -----------
 `name`<br/>*string* | The name of the new environment. Should be unique in the environment and only contain lower case characters, numbers, dashes and underscores.
 `description`<br/>*string* | The description of the new environment.
-`serviceConnection`<br/>*[ServiceConnection](#service-connections)* | The service connection that the environment should be created in<br/>*required*: `id`
+`serviceConnection`<br/>*[ServiceConnection](#administration-service-connections)* | The service connection that the environment should be created in<br/>*required*: `id`
 
 Optional | &nbsp;
 -------- | -----------
-`organization`<br/>*[Organization](#organizations)* | The organization that the environment should be created in. *Defaults to your organization*<br/>*required*: `id`
+`organization`<br/>*[Organization](#administration-organizations)* | The organization that the environment should be created in. *Defaults to your organization*<br/>*required*: `id`
 `membership`<br/>*string* | Type of membership of the environment. ALL_ORG_USERS will add every user in the organization to this environment with the default role. MANY_USERS will allow you to  choose the users you want in the environment and assigned them specific roles. *Defaults to MANY_USERS*
-`roles`<br/>*Array[[Role](#roles)]* | The roles of the environment and the users assigned to them. Also, defines the default role of the environment.<br/>*required*: `name`, `users.id`<br/>*optional*: `isDefault`
+`roles`<br/>*Array[[Role](#administration-roles)]* | The roles of the environment and the users assigned to them. Also, defines the default role of the environment.<br/>*required*: `name`, `users.id`<br/>*optional*: `isDefault`
 
 
-##### Returns
-
-The responses' `data` field contains the updated [environment](#environments).
+The responses' `data` field contains the updated [environment](#administration-environments).
 
 
 <!-------------------- UPDATE ENVIRONMENT -------------------->
@@ -216,7 +214,7 @@ Optional | &nbsp;
 `name`<br/>*string* | The updated name of the environment. Should be unique in the environment and only contain lower case characters, numbers, dashes and underscores.
 `description`<br/>*string* | The updated description of the environment
 `membership`<br/>*string* | Type of membership of the environment. ALL_ORG_USERS will add every user in the organization to this environment with the default role. MANY_USERS will allow you to  choose the users you want in the environment and assigned them specific roles. *Defaults to MANY_USERS*
-`roles`<br/>*Array[[Role](#roles)]* | Update the users roles in the environment. Also, can also update the default role.<br/>*required*: `name`, `users.id`<br/>*optional*: `isDefault`
+`roles`<br/>*Array[[Role](#administration-roles)]* | Update the users roles in the environment. Also, can also update the default role.<br/>*required*: `name`, `users.id`<br/>*optional*: `isDefault`
 
 
 You will need the `Environments update` permission to execute this operation.
@@ -236,7 +234,7 @@ curl "https://cloudmc_endpoint/v1/environments/[environment-id]" \
 
 ```
 
-Delete a specific environment. You will need a [role](#roles) with the `Delete an existing environment	` permission to execute this operation.
+Delete a specific environment. You will need a [role](#administration-roles) with the `Delete an existing environment	` permission to execute this operation.
 
 <aside class="warning">
   <strong>Be careful:</strong> This will destroy all the resources in your environment.

source/includes/administration/_organizations.md

@@ -1,5 +1,5 @@
 ## Organizations
-Organizations are the largest logical grouping of users, environments and resources available in CloudMC. Each organization is isolated from other organizations. It has its own subdomain (`[entryPoint].CloudMC`) and is protected by its own customizable system [roles](#roles). An administrator that must manage it's sub-organizations environments or provisioned resources can do so by having the `Access other levels` permission. Additionally, provisioned resource usage is metered at the organization level facilitating cost tracking.
+Organizations are the largest logical grouping of users, environments and resources available in CloudMC. Each organization is isolated from other organizations. It has its own subdomain (`[entryPoint].CloudMC`) and is protected by its own customizable system [roles](#administration-roles). An administrator that must manage it's sub-organizations environments or provisioned resources can do so by having the `Access other levels` permission. Additionally, provisioned resource usage is metered at the organization level facilitating cost tracking.
 
 
 <!-------------------- LIST ORGANIZATIONS -------------------->
@@ -59,11 +59,11 @@ Attributes | &nbsp;
 `id`<br/>*UUID* | ---
 `name`<br/>*string* | ---
 `entryPoint`<br/>*string* | The entry point of the organization is the subdomain of the organization in the CloudMC URL : `[entryPoint].CloudMC`
-`parent`<br/>*[Organization](#organizations)* | If the organization is a sub-organization, it will have it's `parent` organization. *includes*:`id`,`name`
-`environments`<br/>*Array[[Environment](#environments)]* | The environments belonging to the organization<br/>*includes*: `id`
-`roles`<br/>*Array[[Role](#roles)]* | The system and environments roles belonging to the organization<br/>*includes*: `id`
-`serviceConnections`<br/>*Array[[ServiceConnection](#service-connections)]* | The services for which the organization is allowed to provision resources<br/>*includes*: `id`,`serviceCode`
-`users`<br/>*Array[[User](#users)]* | The users of the organization<br/>*includes*: `id`
+`parent`<br/>*[Organization](#administration-organizations)* | If the organization is a sub-organization, it will have it's `parent` organization. *includes*:`id`,`name`
+`environments`<br/>*Array[[Environment](#administration-environments)]* | The environments belonging to the organization<br/>*includes*: `id`
+`roles`<br/>*Array[[Role](#administration-roles)]* | The system and environments roles belonging to the organization<br/>*includes*: `id`
+`serviceConnections`<br/>*Array[[ServiceConnection](#administration-service-connections)]* | The services for which the organization is allowed to provision resources<br/>*includes*: `id`,`serviceCode`
+`users`<br/>*Array[[User](#administration-users)]* | The users of the organization<br/>*includes*: `id`
 
 <!-------------------- FIND ORGANIZATION -------------------->
 ### Retrieve an organization
@@ -120,11 +120,11 @@ Attributes | &nbsp;
 `id`<br/>*UUID* | ---
 `name`<br/>*string* | ---
 `entryPoint`<br/>*string* | The entry point of the organization is the subdomain of the organization in the CloudMC URL :<br/>`[entryPoint].CloudMC`
-`parent`<br/>*[Organization](#organizations)* | If the organization is a sub-organization, it will have it's `parent` organization. *includes*:`id`,`name`
-`environments`<br/>*Array[[Environment](#environments)]* | The environments belonging to the organization<br/>*includes*: `id`
-`roles`<br/>*Array[[Role](#roles)]* | The system and environments roles belonging to the organization<br/>*includes*: `id`
-`serviceConnections`<br/>*Array[[ServiceConnection](#service-connections)]* | The services for which the organization is allowed to provision resources<br/>*includes*: `id`,`serviceCode`
-`users`<br/>*Array[[User](#users)]* | The users of the organization<br/>*includes*: `id`
+`parent`<br/>*[Organization](#administration-organizations)* | If the organization is a sub-organization, it will have it's `parent` organization. *includes*:`id`,`name`
+`environments`<br/>*Array[[Environment](#administration-environments)]* | The environments belonging to the organization<br/>*includes*: `id`
+`roles`<br/>*Array[[Role](#administration-roles)]* | The system and environments roles belonging to the organization<br/>*includes*: `id`
+`serviceConnections`<br/>*Array[[ServiceConnection](#administration-service-connections)]* | The services for which the organization is allowed to provision resources<br/>*includes*: `id`,`serviceCode`
+`users`<br/>*Array[[User](#administration-users)]* | The users of the organization<br/>*includes*: `id`
 
 <!-------------------- CREATE ORGANIZATION -------------------->
 ### Create organization
@@ -165,10 +165,10 @@ Required | &nbsp;
 
 Optional | &nbsp;
 ---- | ----
-`serviceConnections`<br/>Array[[ServiceConnection](#service-connections)] | A list of service connections for which the organization may provision resources.<br/>*required :*`id`
-`parent`<br/>[Organization](#organization) | The organization that will be the parent of the new organization. By default, it will default to the caller's organization.<br/>*required :*`id`
+`serviceConnections`<br/>Array[[ServiceConnection](#administration-service-connections)] | A list of service connections for which the organization may provision resources.<br/>*required :*`id`
+`parent`<br/>[Organization](#administration-organization) | The organization that will be the parent of the new organization. By default, it will default to the caller's organization.<br/>*required :*`id`
 
-The responses' `data` field contains the created [organization](#organizations) with it's `id`.
+The responses' `data` field contains the created [organization](#administration-organizations) with it's `id`.
 
 <!-------------------- UPDATE ORGANIZATION -------------------->
 ### Update organization
@@ -204,9 +204,9 @@ Required | &nbsp;
 
 Optional | &nbsp;
 ---- | ----
-`serviceConnections`<br/>Array[[ServiceConnection](#service-connections)] | A list of service connections for which the organization may provision resources. The caller must have access to all connections that are provided. **NB :** Service connection access may be added but not revoked at this time.<br/>*required :* `id`
+`serviceConnections`<br/>Array[[ServiceConnection](#administration-service-connections)] | A list of service connections for which the organization may provision resources. The caller must have access to all connections that are provided. **NB :** Service connection access may be added but not revoked at this time.<br/>*required :* `id`
 
-The responses' `data` field contains the updated [organization](#organizations).
+The responses' `data` field contains the updated [organization](#administration-organizations).
 
 <!-------------------- DELETE ORGANIZATION -------------------->
 ### Delete organization

source/includes/administration/_service_connections.md

@@ -1,9 +1,6 @@
 ## Service connections
 
-Service connections are the services that you can create resources for (e.g. compute, object storage). [Environments](#environments) are created for a specific service which allows you to create and manage resources within that service.
-
-<!---- The service APIs are documented [here](#serviceApis) ---->
-
+Service connections are the services that you can create resources for (e.g. compute, object storage). [Environments](#administration-environments) are created for a specific service which allows you to create and manage resources within that service.
 
 <!-------------------- LIST ORGANIZATIONS -------------------->
 ### List service connections

source/includes/administration/_usage.md

@@ -44,8 +44,8 @@ Retrieve the usage summary records for an organization and all of its sub-organi
 
 Attributes |  
 ---- | -----------
-`organizationId`<br/>*UUID* | Id of the [organization](#organizations)
-`serviceConnectionId`<br/>*UUID* | Id of the [service connection](#service-connections)
+`organizationId`<br/>*UUID* | Id of the [organization](#administration-organizations)
+`serviceConnectionId`<br/>*UUID* | Id of the [service connection](#administration-service-connections)
 `serviceConnectionPricingId`<br/>*UUID* | Id of the service connection pricing
 `utilityCost`<br/>*string* | Utility cost of the record (aggregated per the period)
 `utilityUsage`<br/>*string* | Utility usage of the record