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

AV-55075: add Tab Sync Group #53

Open
wants to merge 2 commits into
base: release/7.2
Choose a base branch
from

Conversation

osfameron
Copy link
Collaborator

Noticed that on https://docs-staging.couchbase.com/server/current/guides/updating-data.html the 3rd set of tabs don't synchronise, because cbc-subdoc is a different string than cbc

This commit sets them all in the same "sync group" so they match for e.g. .NET, Java, etc.

(cbc and cbc-subdoc still won't synchronize though. That doesn't seem to be customizable from https://github.com/asciidoctor/asciidoctor-tabs#tabs-sync Consider rewording both to cbc or CLI or similar if that would be desirable.)

Noticed that on https://docs-staging.couchbase.com/server/current/guides/updating-data.html
the 3rd set of tabs don't synchronise, because `cbc-subdoc` is a
different string than `cbc`

This commit sets them all in the same "sync group" so they match for
e.g. .NET, Java, etc.

(cbc and cbc-subdoc still won't synchronize though.
That doesn't seem to be customizable from https://github.com/asciidoctor/asciidoctor-tabs#tabs-sync
Consider rewording both to `cbc` or `CLI` or similar if that would be
desirable.)
Copy link
Collaborator

@simon-dew simon-dew left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This works beautifully, and vastly improves the user experience for tabs. I'd be happy to change the cbc-subdoc tabs to match the cbc tabs to ensure that they sync correctly. But:

  1. This affects more than just the updating-data page; need update all pages with cbc / cbc-subdoc tabs.
  2. We need to decide on what to call the unified command line tabs. The obvious answer would be to rename cbc-subdoc to cbc. But this is inaccurate as they are two separate tools. Maybe better to standardise on CLI for the CLI tabs, as you suggested.
  3. Just to note that the links to the SDK API documentation is broken. Should be https://docs.couchbase.com/sdk-api/couchbase-c-client/md_doc_2cbc-subdoc.html

Happy for this to be a separate PR from this ticket or a new ticket.

remove `tab-sync-group` parameter, and instead rename all of `cbc` and
`cbc-subdoc` to `CLI` so that they inherit the useful default behaviour.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants