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

DOC-5475: Remove unnecessary version information #1276

Merged
merged 4 commits into from
May 14, 2020

Conversation

simon-dew
Copy link
Collaborator

@simon-dew simon-dew commented Apr 30, 2020

Docs issue: DOC-5475

  • Removed (Introduced in ...) captions for versions earlier than 6.5.
  • Removed :page-status: attribute for versions earlier than 6.5.
  • Removed section status role for features that were not specific to a patch release.

The orange status label should now only appear in the following cases:

  1. For pages only: to show that this feature is new in the current version.
  2. For pages only: to show that this feature is specific to a developer preview.
  3. For sections within a page: to show that a feature is specific to a patch release.

The italic (Introduced in ...) caption should now only appear in the following cases:

  1. For sections within a page: to show that this feature is new in the current version.

Anecdotal comments about versions, e.g. "Since Couchbase Server 5.5, you can..." still occur in the running text — I think this is okay.

@simon-dew simon-dew requested a review from a team April 30, 2020 13:27
@simon-dew
Copy link
Collaborator Author

simon-dew commented Apr 30, 2020

I also added ifeval::['{page-component-version}' == '6.5'] directives to future-proof any captions stating (Introduced in Couchbase Server 6.5). This means that when we create the release/6.6 branch, these captions will be hidden automatically.

@amarantha-k amarantha-k self-requested a review May 13, 2020 17:31
Copy link
Contributor

@amarantha-k amarantha-k left a comment

Choose a reason for hiding this comment

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

Thanks for taking care of these! lgtm

@amarantha-k amarantha-k merged commit 5eec14a into couchbase:release/6.5 May 14, 2020
@simon-dew simon-dew deleted the DOC-5475-65 branch August 24, 2020 13:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants