diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6a81d6a8c6..1f69a82562 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -89,8 +89,8 @@ Specs The [``swift-specs``](https://github.com/openstack/swift-specs) repo can be used for collaborative design work before a feature is implemented. -Openstack's gerrit system is used to collaborate on the design spec. Once -approved Openstack provides a doc site to easily read these [specs](http://specs.openstack.org/openstack/swift-specs/) +OpenStack's gerrit system is used to collaborate on the design spec. Once +approved OpenStack provides a doc site to easily read these [specs](http://specs.openstack.org/openstack/swift-specs/) A spec is needed for more impactful features. Coordinating a feature between many devs (especially across companies) is a great example of when a spec is diff --git a/doc/source/associated_projects.rst b/doc/source/associated_projects.rst index 22b9f8bddd..8f2ce5f072 100644 --- a/doc/source/associated_projects.rst +++ b/doc/source/associated_projects.rst @@ -25,7 +25,7 @@ Application Bindings * `java-openstack-swift `_ - Java bindings for OpenStack Swift * `swift_client `_ - Small but powerful Ruby client to interact with OpenStack Swift * `nightcrawler_swift `_ - This Ruby gem teleports your assets to a OpenStack Swift bucket/container - * `swift storage `_ - Simple Openstack Swift storage client. + * `swift storage `_ - Simple OpenStack Swift storage client. Authentication -------------- @@ -107,7 +107,7 @@ Other * `Glance `_ - Provides services for discovering, registering, and retrieving virtual machine images (for OpenStack Compute [Nova], for example). * `Better Staticweb `_ - Makes swift containers accessible by default. * `Swiftsync `_ - A massive syncer between two swift clusters. -* `Django Swiftbrowser `_ - Simple Django web app to access Openstack Swift. +* `Django Swiftbrowser `_ - Simple Django web app to access OpenStack Swift. * `Swift-account-stats `_ - Swift-account-stats is a tool to report statistics on Swift usage at tenant and global levels. * `PyECLib `_ - High Level Erasure Code library used by Swift * `liberasurecode `_ - Low Level Erasure Code library used by PyECLib diff --git a/doc/source/howto_installmultinode.rst b/doc/source/howto_installmultinode.rst index 6337cce527..e45a8adb77 100644 --- a/doc/source/howto_installmultinode.rst +++ b/doc/source/howto_installmultinode.rst @@ -3,31 +3,31 @@ Instructions for a Multiple Server Swift Installation ===================================================== Please refer to the latest official -`Openstack Installation Guides `_ +`OpenStack Installation Guides `_ for the most up-to-date documentation. -Object Storage installation guide for Openstack Liberty +Object Storage installation guide for OpenStack Liberty ------------------------------------------------------- * `openSUSE 13.2 and SUSE Linux Enterprise Server 12 `_ * `RHEL 7, CentOS 7 `_ * `Ubuntu 14.04 `_ -Object Storage installation guide for Openstack Kilo +Object Storage installation guide for OpenStack Kilo ---------------------------------------------------- * `openSUSE 13.2 and SUSE Linux Enterprise Server 12 `_ * `RHEL 7, CentOS 7, and Fedora 21 `_ * `Ubuntu 14.04 `_ -Object Storage installation guide for Openstack Juno +Object Storage installation guide for OpenStack Juno ---------------------------------------------------- * `openSUSE 13.1 and SUSE Linux Enterprise Server 11 `_ * `RHEL 7, CentOS 7, and Fedora 20 `_ * `Ubuntu 14.04 `_ -Object Storage installation guide for Openstack Icehouse +Object Storage installation guide for OpenStack Icehouse -------------------------------------------------------- * `openSUSE and SUSE Linux Enterprise Server `_ diff --git a/doc/source/overview_auth.rst b/doc/source/overview_auth.rst index 42e1ad029e..29ac1459e9 100644 --- a/doc/source/overview_auth.rst +++ b/doc/source/overview_auth.rst @@ -207,7 +207,7 @@ that the user is allowed to operate on project resources. OpenStack Service Using Composite Tokens ---------------------------------------- -Some Openstack services such as Cinder and Glance may use +Some OpenStack services such as Cinder and Glance may use a "service account". In this mode, you configure a separate account where the service stores project data that it manages. This account is not used directly by the end-user. Instead, all access is done through the service. @@ -234,19 +234,19 @@ situation as follows: (see ``/etc/keystone/default_catalog.templates`` above). Normally this is ``AUTH``. * The second item in the reseller_prefix list is the prefix used by the - Openstack services(s). You must configure this value (``SERVICE`` in the - example) with whatever the other Openstack service(s) use. + OpenStack services(s). You must configure this value (``SERVICE`` in the + example) with whatever the other OpenStack service(s) use. * Set the operator_roles option to contain a role or roles that end-user's have on project's they use. * Set the SERVICE_service_roles value to a role or roles that only the - Openstack service user has. Do not use a role that is assigned to + OpenStack service user has. Do not use a role that is assigned to "normal" end users. In this example, the role ``service`` is used. The service user is granted this role to a *single* project only. You do not need to make the service user a member of every project. This configuration works as follows: -* The end-user presents a user token to an Openstack service. The service +* The end-user presents a user token to an OpenStack service. The service then makes a Swift request to the account with the ``SERVICE`` prefix. * The service forwards the original user token with the request. It also adds it's own service token. diff --git a/doc/source/overview_backing_store.rst b/doc/source/overview_backing_store.rst index 57f7f37123..db50f65ea2 100644 --- a/doc/source/overview_backing_store.rst +++ b/doc/source/overview_backing_store.rst @@ -15,7 +15,7 @@ Glance writes the image to a Swift container as a set of objects. Throughout this section, the following terminology and concepts are used: * User or end-user. This is a person making a request that will result in - an Openstack Service making a request to Swift. + an OpenStack Service making a request to Swift. * Project (also known as Tenant). This is the unit of resource ownership. While data such as snapshot images or block volume backups may be @@ -182,7 +182,7 @@ Using the HTTP_X_SERVICE_CATALOG to get Swift Account Name The auth_token middleware populates the wsgi environment with information when it validates the user's token. The HTTP_X_SERVICE_CATALOG item is a JSON -string containing details of the Openstack endpoints. For Swift, this also +string containing details of the OpenStack endpoints. For Swift, this also contains the project's Swift account name. Here is an example of a catalog entry for Swift:: @@ -236,7 +236,7 @@ requirement is that your Service User has the appropriate role. In practice: reseller_prefix = AUTH_, SERVICE_ SERVICE_service_role = service -The ``service`` role should only be granted to Openstack Services. It should +The ``service`` role should only be granted to OpenStack Services. It should not be granted to users. Single or multiple Service Prefixes? @@ -244,7 +244,7 @@ Single or multiple Service Prefixes? Most of the examples used in this document used a single prefix. The prefix, ``SERVICE`` was used. By using a single prefix, an operator is -allowing all Openstack Services to share the same account for data +allowing all OpenStack Services to share the same account for data associated with a given project. For test systems or deployments well protected on private firewalled networks, this is appropriate. @@ -270,4 +270,4 @@ Container Naming Since a single Service Prefix is possible, container names should be prefixed with a unique string to prevent name clashes. We suggest you use the service type field (as used in the service catalog). For example, The Glance Service -would use "image" as a prefix. \ No newline at end of file +would use "image" as a prefix.