Update some docs for some nits found (#286)
* A few small doc clarifications
First of all, remove reference to HP as an OpenStack provider and
replace with some other examples of folks who are actually running
OpenStack Public Clouds.
Then add a few notes clarifying tenant/project usage and the fact that
domain applies to both.
* Change my-openstack.com to openstack.example.com
RFC 2606 defines example.com as a reserved domain to be used in tests
and examples. It is guaranteed to not be actually resolvable. Update
the uses of my-openstack.com to use example.com instead.
https://tools.ietf.org/html/rfc2606
* Change "cluster" to "cloud"
The general term for an installation of OpenStack is cloud, at least
when talking to end users.
* Address review comments
diff --git a/doc.go b/doc.go
index fb81a9d..b559516 100644
--- a/doc.go
+++ b/doc.go
@@ -4,11 +4,13 @@
resources.
Provider structs represent the service providers that offer and manage a
-collection of services. Examples of providers include: OpenStack, Rackspace,
-HP. These are defined like so:
+collection of services. The IdentityEndpoint is typically refered to as
+"auth_url" in information provided by the cloud operator. Additionally,
+the cloud may refer to TenantID or TenantName as project_id and project_name.
+These are defined like so:
opts := gophercloud.AuthOptions{
- IdentityEndpoint: "https://my-openstack.com:5000/v2.0",
+ IdentityEndpoint: "https://openstack.example.com:5000/v2.0",
Username: "{username}",
Password: "{password}",
TenantID: "{tenant_id}",