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

DBZ-2645 Add Vitess connector documentation #1895

Conversation

keweishang
Copy link
Member

@keweishang keweishang commented Oct 17, 2020

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.

@keweishang keweishang force-pushed the DBZ-2645-add-vitess-connector-documentation branch from 8191703 to 96041de Compare October 19, 2020 13:09
@keweishang
Copy link
Member Author

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.

@Naros
Copy link
Member

Naros commented Oct 19, 2020

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 {context} variable used in links as part of the shared metrics templates. If I may ask, which connector did you use as a basis for the vitess.adoc? I just want to make sure that there aren't any other changes needed.

@keweishang
Copy link
Member Author

@Naros Thanks for reviewing. I've just committed the suggested change. I've used postgresql.adoc as the basis for the vitess.adoc. Let me know if other changes are needed.

@keweishang keweishang force-pushed the DBZ-2645-add-vitess-connector-documentation branch from 816b324 to e284bbf Compare October 20, 2020 07:27
Copy link
Member

@gunnarmorling gunnarmorling left a 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[]
Copy link
Member

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.

Copy link
Member Author

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.

Copy link
Member Author

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.

@keweishang keweishang force-pushed the DBZ-2645-add-vitess-connector-documentation branch 2 times, most recently from d523295 to fc69eab Compare October 21, 2020 07:48
@keweishang keweishang force-pushed the DBZ-2645-add-vitess-connector-documentation branch from fc69eab to 57d8d13 Compare October 21, 2020 11:20
@jpechane jpechane merged commit f212b46 into debezium:master Oct 21, 2020
@jpechane
Copy link
Contributor

@keweishang Great job! Applied

@keweishang
Copy link
Member Author

Awesome! Thank you @jpechane

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