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
DBZ-2645 Add Vitess connector documentation #1895
DBZ-2645 Add Vitess connector documentation #1895
Conversation
8191703
to
96041de
Compare
I used https://github.com/debezium/debezium.github.io to build the website locally that contains the documentation from the main debezium repo. It looks good to me. |
We had some recent changes to the documentation as a part of DBZ-2497. I've requested one tiny change above that should address the |
@Naros Thanks for reviewing. I've just committed the suggested change. I've used |
816b324
to
e284bbf
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wow, great work! Thanks a lot, @keweishang! One comment inline.
|
||
{prodname}'s Vitess connector captures row-level changes in the shards of a Vitess link:https://vitess.io/docs/concepts/keyspace/[keyspace]. Vitess versions 7 and 8 are supported. | ||
endif::community[] | ||
ifdef::product[] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So you don't really need the ifdefs at this point. We have those in other connector docs to customize contents between what's shown in the community docs (i.e. on debezium.io/docs) and what's shown in downstream product docs. As this connector is only part of the community distribution, we just can go with a single flavour of these contents and remove the conditionals. Should we decide to include this connector in the downstream offering, we'd revisit this, but then Red Hat docs writers will be able to help with the job. For now I'd suggest to keep things simple.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for pointing this out. I actually had the same question. I'll remove the product ifdef
parts.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I removed all the ifdef::product[]
. I also kept the content of the ifdef::community[]
, but removed the ifdef::community[]
logic.
d523295
to
fc69eab
Compare
fc69eab
to
57d8d13
Compare
@keweishang Great job! Applied |
Awesome! Thank you @jpechane |
https://issues.redhat.com/browse/DBZ-2645
Hi @gunnarmorling, is there a way to build the documentation and website locally to check if everything works? Thanks.