-
Task
-
Resolution: Done
-
Major
-
None
-
None
Testing revealed several unresolved links in the documentation.
Getting Started guide:
- Chapter 1 - Deploying and Upgrading AMQ Streams on OpenShift --> Target content was moved to new location in Deploying and Managing Streams
- Chapter 1 - To store the build image as a native OpenShift ImageStream <-- Image stream link does not work --> _Target content was moved. REMOVE link.
- Chapter 1 - Managing image streams on OpenShift Container Platform. --> Update link in Additional resources section to point to Managing ImageStreams in the OpenShift docs.
- Chapter 2 - There is no word about how to deploy AMQ streams operator, and Kafka I think at least link to AMQ streams getting started would be nice ... --> This content is shared from the file proc-using-streams-to-deploy-a-debezium-mysql-sqlserver-connector.adoc, that is present in the upstream repo.
I had hoped to avoid touching that by addressing modifying only the version of the file in the downstream repo, adding a prerequisites section at the beginning of Chapter 3 that includes the following links to Streams topics: *- Deploying a Cluster Operator (Getting Started with Streams guide)
- Deploying Kafka (Deploying and Managing Streams)
- Deploying Kafka Connect (Deploying and Managing Streams).
OCP Installation guide:
- Chapter 2.2.1 - Deploying and Upgrading AMQ Streams on OpenShift -> Target content was moved to new location in Deploying and Managing Streams.
- Chapter 2.2.1 - Kafka Connect is deployed on AMQ Streams --> Target content was moved to new location in Deploying and Managing Streams.
- Chapter 2.2.1 - ImageStream <-- link does not work ==> --> Target content was moved. REMOVE link.
- Chapter 2.2.1 - Managing image streams on OpenShift Container Platform. --> Target content was moved. Remove link and update link in Additional resources section to point to Managing ImageStreams in the OpenShift docs.
The updates to fix these issues apply to the downstream version of the documentation only. No changes required in the community docs.*
* The upstream tutorial and downstream Getting Started guides share content. For the 2.3.4 downstream release, the documentation build was unstable. Where possible, to avoid rebuilding content in toto, I think it best to apply downstream-only fixes to add new information.