Skip to content

Commit c69c8f5

Browse files
fix links and attributes on project readme pages (#435)
* fix links and attributes on readme pages, add missing guides * fix consumer groups link * Update README.adoc Co-authored-by: Breda McColgan <[email protected]> * Update README.adoc Co-authored-by: Breda McColgan <[email protected]> * Update README.adoc Co-authored-by: Breda McColgan <[email protected]> * Update README.adoc Co-authored-by: Breda McColgan <[email protected]> * Update README.adoc Co-authored-by: Breda McColgan <[email protected]> * Update README.adoc Co-authored-by: Breda McColgan <[email protected]> * Update README.adoc Co-authored-by: Breda McColgan <[email protected]> * Update CONTRIBUTING.adoc Co-authored-by: Breda McColgan <[email protected]> Co-authored-by: Breda McColgan <[email protected]>
1 parent beed1d7 commit c69c8f5

File tree

2 files changed

+29
-18
lines changed

2 files changed

+29
-18
lines changed

CONTRIBUTING.adoc

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
:product: App Services
2+
:product-kafka: Streams for Apache Kafka
3+
:product-registry: Service Registry
4+
5+
= Contributing to {product} guides
26

3-
= Contributing to {product-kafka} guides
47

58
== Prerequisites
69

@@ -41,7 +44,7 @@ npm --prefix .build run generate:attributes
4144

4245
== Repository structure
4346

44-
This repository is designed to be usable for people browsing it on GitHub, as well as reusable (e.g. in quick starts) in implementations of {product-kafka}.
47+
This repository is designed to be usable for people browsing it on GitHub, as well as reusable (for example, in quick starts) in implementations of services such as {product-kafka} or {product-registry}.
4548

4649
Each guide is contained in a separate directory. The directory must contain:
4750

README.adoc

Lines changed: 24 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,39 @@
11
:product: App Services
2+
:product-long-kafka: OpenShift Streams for Apache Kafka
3+
:product-long-registry: OpenShift Service Registry
24

5+
= {product} guides and samples
36

7+
== {product-long-kafka} guides
48

5-
= {product} Guides and Samples
9+
* link:./docs/kafka/getting-started-kafka[Getting started with {product-long-kafka}]
10+
* link:./docs/kafka/rhoas-cli-getting-started-kafka[Getting started with the rhoas CLI for {product-long-kafka}]
11+
* link:./docs/kafka/quarkus-kafka[Using Quarkus applications with Kafka instances in {product-long-kafka}]
12+
* link:./docs/kafka/kcat-kafka[Configuring and connecting Kafkacat with {product-long-kafka}]
13+
* link:./docs/kafka/kafka-bin-scripts-kafka[Configuring and connecting Kafka scripts with {product-long-kafka}]
14+
* link:./docs/kafka/access-mgmt-kafka[Managing account access in {product-long-kafka}]
15+
* link:./docs/kafka/service-binding-kafka[Binding OpenShift applications to {product-long-kafka}]
16+
* link:./docs/kafka/topic-configuration-kafka[Configuring topics in {product-long-kafka}]
17+
* link:./docs/kafka/nodejs-kafka[Using Node.js applications with Kafka instances in {product-long-kafka}]
18+
* link:./docs/kafka/metrics-monitoring-kafka[Monitoring metrics in {product-long-kafka}]
19+
* link:./docs/kafka/consumer-configuration-kafka[Configuring consumer groups in {product-long-kafka}]
620

7-
== Guides
21+
== {product-long-registry} guides
822

9-
* link:./docs/kafka/getting-started[Getting started with {product-kafka}]
10-
* link:./rhoas-cli[Installing and configuring the `rhoas` CLI]
11-
* link:./docs/service-discovery[Binding OpenShift applications to {product-kafka}]
23+
* link:./docs/registry/getting-started-registry/[Getting started with {product-long-registry}]
24+
* link:./docs/registry/access-mgmt-registry[Managing account access in {product-long-registry}]
25+
* link:./docs/registry/rhoas-cli-registry[Getting started with the rhoas CLI for {product-long-registry}]
26+
* link:./docs/registry/quarkus-registry[Using Quarkus applications with Kafka instances and {product-long-registry} instances]
1227

13-
== OpenShift Streams For Apache Kafka Guides
28+
== Core guides
1429

15-
* link:./docs/kafka/rhoas-cli-kafka[Getting started with the `rhoas` CLI for OpenShift Streams for Apache Kafka]
16-
* link:./docs/kafka/quarkus[Using Quarkus applications with Kafka instances in {product-kafka}]
17-
* link:./docs/kafka/kafkacat[Using Kafkacat with Kafka instances in {product-kafka}]
18-
* link:./docs/kafka/kafka-bin-scripts[Using Kafka bin scripts with {product-kafka}]
19-
20-
== OpenShift Service Registry Guides
21-
22-
* link:./docs/registry/rhoas-cli-service-registry[Getting started with the `rhoas` CLI for OpenShift Service Registry]
23-
* link:./docs/registry/getting-started-service-registry/[Getting started with Service Registry]
30+
* link:./docs/rhoas/rhoas-cli-installation[Installing and configuring the rhoas CLI]
2431

2532
== Application examples used in guides
2633

2734
* link:./code-examples/quarkus-kafka-quickstart[Quarkus Kafka quick start]
35+
* link:./code-examples/quarkus-service-registry-quickstart[Quarkus Kafka Service Registry quick start]
2836

2937
== Contributing
3038

31-
* link:./CONTRIBUTING.adoc[Contributing to {product-kafka} guides]
39+
* link:./CONTRIBUTING.adoc[Contributing to {product} guides]

0 commit comments

Comments
 (0)