wso2 / wso2/docs-apim

Issues identified when trying out tutorial Expose a Kafka Stream as a Managed WebSocket API

Open Beginner friendly
#6,840 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Type/Docs
Dominant language
CSS
Stars
99
Forks
708
Avg merge
1d 7h
Merged PRs (30d)
22

Description

Description:
The following issues were identified when trying out [1].

  1. Under Prerequisites - 1. Configure the Streaming Integrator, point 4a instructs the user to copy keys from the APIM pack to the SI pack. It is better to mention that the same keys should be copied to the <SI_TOOLING_HOME>/resources/security/ directory as well because not doing so would result in an error at the time the user deploys the Siddhi application from SI Tooling to SI Server.

  2. In Step 6 - View the service catalog entry in WSO2 API-M, the screenshot of the service catalog shows a list of services that does not include the service that we have created in the previous steps.

[1] https://apim.docs.wso2.com/en/latest/use-cases/streaming-tutorials/expose-a-kafka-topic-as-a-managed-websocket-api/

Suggested Labels:

Suggested Assignees:

Affected Product Version:

OS, DB, other environment details and versions:

Steps to reproduce:

Related Issues:

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the linked streaming tutorial and review Prerequisites - 1, point 4a, and Step 6. Update the prerequisite to mention copying the keys into <SI_TOOLING_HOME>/resources/security/, and update the Step 6 service-catalog screenshot so it includes the service created earlier. Done means the instructions and screenshot match the tutorial flow.

Written by the indexing model from the issue text.

Assessment

Tech stack
kafka
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
62/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.