Skip to content

Commit 0720cf9

Browse files
mmacypmorie
authored andcommitted
minor README copy edit (openshift#1656)
* minor README copy edit * minor README copy edit * Remove empty examples mention
1 parent 8bd347d commit 0720cf9

File tree

1 file changed

+25
-27
lines changed

1 file changed

+25
-27
lines changed

Diff for: README.md

+25-27
Original file line numberDiff line numberDiff line change
@@ -17,28 +17,28 @@ knowledge about how those services are created or managed.
1717

1818
As an example:
1919

20-
Most applications need a datastore of some kind. The service-catalog allows
20+
Most applications need a datastore of some kind. The service-catalog allows
2121
Kubernetes applications to consume services like databases that exist
2222
_somewhere_ in a simple way:
2323

24-
1. A user wanting to consume a database in their application browses a list of
24+
1. A user wanting to consume a database in their application browses a list of
2525
available services in the catalog
26-
2. The user asks for a new instance of that service to be _provisioned_
26+
2. The user asks for a new instance of that service to be _provisioned_
2727

28-
_Provisioning_ means that the broker somehow creates a new instance of a
29-
service. This could mean basically anything that results in a new instance
30-
of the service becoming available. Possibilities include: creating a new
31-
set of Kubernetes resources in another namespace in the same Kubernetes
32-
cluster as the consumer or a different cluster, or even creating a new
33-
tenant in a multi-tenant SaaS system. The point is that the
34-
consumer doesn't have to be aware of or care at all about the details.
35-
3. The user requests a _binding_ to use the service instance in their application
28+
_Provisioning_ means that the broker somehow creates a new instance of a
29+
service. This could mean basically anything that results in a new instance
30+
of the service becoming available. Possibilities include: creating a new
31+
set of Kubernetes resources in another namespace in the same Kubernetes
32+
cluster as the consumer or a different cluster, or even creating a new
33+
tenant in a multi-tenant SaaS system. The point is that the
34+
consumer doesn't have to be aware of or care at all about the details.
35+
3. The user requests a _binding_ to use the service instance in their application
3636

3737
Credentials are delivered to users in normal Kubernetes secrets and
3838
contain information necessary to connect to and authenticate to the
3939
service instance.
4040

41-
For more introduction, including installation and self-guided demo
41+
For more introduction, including installation and self-guided demo
4242
instructions, please see the [introduction](./docs/introduction.md) doc.
4343

4444
For more details about the design and features of this project see the
@@ -52,11 +52,11 @@ For more details about the design and features of this project see the
5252

5353
---
5454

55-
### Overall Status
55+
### Project Status
5656

5757
We are currently working toward a beta-quality release to be used in conjunction with
5858
Kubernetes 1.8. See the
59-
[milestones list](https://github.com/kubernetes-incubator/service-catalog/milestones?direction=desc&sort=due_date&state=open)
59+
[milestones list](https://github.com/kubernetes-incubator/service-catalog/milestones?direction=desc&sort=due_date&state=open)
6060
for information about the issues and PRs in current and future milestones.
6161

6262
The project [roadmap](https://github.com/kubernetes-incubator/service-catalog/wiki/Roadmap)
@@ -70,45 +70,43 @@ for more information.
7070

7171
Our goal is to have extensive use-case and functional documentation.
7272

73-
See the [main Kubernetes docs](https://kubernetes.io/docs/concepts/service-catalog/)
74-
and additional documentation [here](./docs/v1).
73+
See the [Service Catalog documentation](https://kubernetes.io/docs/concepts/service-catalog/)
74+
on the main Kubernetes site, and the [project documentation](./docs/README.md) here on GitHub.
7575

76-
See [here](https://github.com/kubernetes-incubator/service-catalog/wiki/Examples) for examples and
77-
[here](https://github.com/openservicebrokerapi/servicebroker/blob/master/gettingStarted.md) for
78-
broker servers that are compatible with this software.
76+
For details on broker servers that are compatible with this software, see the
77+
Open Service Broker API project's [Getting Started guide](https://github.com/openservicebrokerapi/servicebroker/blob/master/gettingStarted.md).
7978

8079
### Terminology
8180

8281
This project's problem domain contains a few inconvenient but unavoidable
83-
overloads with other Kubernetes terms. Check out our [terminology page](./terminology.md)
82+
overloads with other Kubernetes terms. Check out our [terminology page](./terminology.md)
8483
for definitions of terms as they are used in this project.
8584

8685
### Contributing
8786

88-
Interested in contributing? Check out the [contributing documentation](./CONTRIBUTING.md).
87+
Interested in contributing? Check out the [contribution guidelines](./CONTRIBUTING.md).
8988

9089
Also see the [developer's guide](./docs/devguide.md) for information on how to
9190
build and test the code.
9291

9392
We have weekly meetings - see
9493
[Kubernetes SIGs](https://github.com/kubernetes/community/blob/master/sig-list.md)
95-
(search for "Service Catalog") for the exact date and time. Our agenda/notes
96-
doc can be found
97-
[here](https://docs.google.com/document/d/17xlpkoEbPR5M6P5VDzNx17q6-IPFxKyebEekCGYiIKM/edit)
94+
(search for "Service Catalog") for the exact date and time. For meeting agendas
95+
and notes, see [Kubernetes SIG Service Catalog Agenda](https://docs.google.com/document/d/17xlpkoEbPR5M6P5VDzNx17q6-IPFxKyebEekCGYiIKM/edit).
9896

99-
Previous Agenda notes are also available:
97+
Previous meeting notes are also available:
10098
[2016-08-29 through 2017-09-17](https://docs.google.com/document/d/10VsJjstYfnqeQKCgXGgI43kQWnWFSx8JTH7wFh8CmPA/edit).
10199

102100
### Kubernetes Incubator
103101

104102
This is a [Kubernetes Incubator project](https://github.com/kubernetes/community/blob/master/incubator.md).
105-
The project was established 2016-Sept-12. The incubator team for the project is:
103+
The project was established 2016-Sept-12. The incubator team for the project is:
106104

107105
- Sponsor: Brian Grant ([@bgrant0607](https://github.com/bgrant0607))
108106
- Champion: Paul Morie ([@pmorie](https://github.com/pmorie))
109107
- SIG: [sig-service-catalog](https://github.com/kubernetes/community/tree/master/sig-service-catalog)
110108

111-
For more information about sig-service-catalog such as meeting times and agenda,
109+
For more information about sig-service-catalog, such as meeting times and agenda,
112110
check out the [community site](https://github.com/kubernetes/community/tree/master/sig-service-catalog).
113111

114112
### Code of Conduct

0 commit comments

Comments
 (0)