Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Hono Documentation to include Kafka #2601

Closed
fkaltner opened this issue Apr 12, 2021 · 8 comments
Closed

Update Hono Documentation to include Kafka #2601

fkaltner opened this issue Apr 12, 2021 · 8 comments
Assignees
Milestone

Comments

@fkaltner
Copy link
Contributor

fkaltner commented Apr 12, 2021

With the upcoming Kafka support the Hono documentation should be adapted, e.g. the CLI documentation, Getting Started and all other places where the messaging network is used.

@b-abel
Copy link
Contributor

b-abel commented May 26, 2021

Regarding the Getting Started guide: the simplest solution would probably be to make a complete copy of the guide with adaptions to Kafka. The two documents can always be integrated later if it becomes apparent that both variants of messaging should be promoted permanently. WDYT?

b-abel added a commit to bosch-io/hono that referenced this issue May 28, 2021
@b-abel
Copy link
Contributor

b-abel commented May 28, 2021

the simplest solution would probably be to make a complete copy of the guide with adaptions to Kafka

#2682 adds this.

b-abel added a commit to bosch-io/hono that referenced this issue May 31, 2021
@fkaltner
Copy link
Contributor Author

fkaltner commented Jun 7, 2021

The two documents can always be integrated later if it becomes apparent that both variants of messaging should be promoted permanently.

@sophokles73 Maybe I missed something, but I thought both variants actually were supposed to coexist permanently?

@sophokles73
Copy link
Contributor

FMPOV there is no reason to discontinue the AMQP support. However, we should still have a preferred setup that we use by default and which we should then also use in the Getting Started guide, right?

@b-abel
Copy link
Contributor

b-abel commented Jun 7, 2021

I am not sure now: can we all agree on the proposal to create two separate documents?

I think there needs to be some sort of end-to-end documentation for each type of messaging system that shows how to use the overall system with clients. The existing Getting Started Guide FMPOV does a great job at this. The differences between AMQP-based and Kafka-based messaging are significant enough that I think it makes sense to have two separate documents for them.
How to name them and where and how prominently they are displayed can still be changed at any time.

@fkaltner
Copy link
Contributor Author

fkaltner commented Jun 7, 2021

If the documents do differ significantly there's no reason not to have them 😃

Maybe I misunderstood what you wrote. I got the impression the argument was to have a (mostly) duplicated copy for now and postpone the effort for integrating both documents later, since the assumption was that one copy may become obsolete...

b-abel added a commit to bosch-io/hono that referenced this issue Aug 5, 2021
b-abel added a commit to bosch-io/hono that referenced this issue Aug 5, 2021
b-abel added a commit to bosch-io/hono that referenced this issue Aug 5, 2021
The external Kafka port used by the Hono Helm chart has been changed from
9094 to 9092. This adapts the Kafka messaging guide accordingly.

Signed-off-by: Abel Buechner-Mihaljevic <[email protected]>
b-abel added a commit to bosch-io/hono that referenced this issue Sep 22, 2021
@sophokles73 sophokles73 added this to the 1.10.0 milestone Sep 23, 2021
sophokles73 pushed a commit that referenced this issue Sep 23, 2021
Added a separate Getting Started guide to the home page based on Kafka based
messaging instead of the default AMQP 1.0 based messaging.

Signed-off-by: Abel Buechner-Mihaljevic <[email protected]>
@sophokles73
Copy link
Contributor

@b-abel @fkaltner can this be closed?

@b-abel
Copy link
Contributor

b-abel commented Sep 23, 2021

FMPOV, yes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants