Skip to content

Commit 67dbabb

Browse files
arschleskibbles-n-bytes
authored andcommitted
Cleaning up the docs README (openshift#1618)
1 parent 6bddc07 commit 67dbabb

File tree

1 file changed

+18
-12
lines changed

1 file changed

+18
-12
lines changed

Diff for: docs/README.md

+18-12
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,22 @@
1-
## service-catalog docs
1+
# Service Catalog docs
22

3-
Start by checking out the [introduction](introduction.md).
3+
Welcome to the documentation for Service Catalog. This page is an index for
4+
the articles in here. We recommend you start by reading the
5+
[introduction](introduction.md), and then move on to the
6+
[installation instructions](./install.md).
47

5-
Topics for users:
6-
- [Installation instructions](install.md)
7-
- [Walkthrough](walkthrough.md)
8-
- [Passing parameters to ServiceInstances and ServiceBindings](parameters.md)
8+
Afterward, see the below list of topics:
99

10-
Topics for developers:
11-
- [Code conventions](code-standards.md)
12-
- [Developer guide](devguide.md)
13-
- [Design](design.md)
14-
- [Notes on authentication](auth.md)
10+
## Topics for users:
11+
- [Passing parameters to ServiceInstances and ServiceBindings](./parameters.md)
1512

16-
We are collecting use-cases and other fundamental documentation for our eventual [V1 GA release here](./v1).
13+
## Topics for developers:
14+
- [Code conventions](./code-standards.md)
15+
- [Developer guide](./devguide.md)
16+
- [Design](./design.md)
17+
- [Notes on authentication](./auth.md)
18+
19+
## Request for Comments
20+
21+
As Service Catalog is in beta, we are collecting use-cases and other
22+
fundamental documentation for our eventual [V1 GA release here](./v1).

0 commit comments

Comments
 (0)