Skip to content

Document Editions, Deprecation, and Version Page Labels #846

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Sep 29, 2025
+54 −1
Merged

Document Editions, Deprecation, and Version Page Labels #846

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
06b38d1
Initial draft of collecting inline page roles for versions, deprecati…
sarahlwelton Sep 26, 2025
5cf9cda
Add Deprecated tag/role
sarahlwelton Sep 26, 2025
209844d
Add suggestions from Simon
sarahlwelton Sep 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions home/modules/contribute/pages/attributes-and-roles.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Attributes and Roles
:page-toclevels: 3

Use attributes and roles to insert content or CSS styles into your pages.

Expand Down Expand Up @@ -103,6 +104,53 @@ I'm a block with an assigned role!
\----
----

=== Inline Roles for Editions, Versions, and Deprecation

Couchbase Documentation created inline page roles for marking sections of documentation as deprecated, for a specific Couchbase Server version, or for marking sections as applying to a specific product edition - similar to <<page-edition,the :page-edition: attribute>>.

You can use the following inline roles to mark sections of text in your documentation:

|====
| Role | Example

a|
[source,asciidoc]
----
[.edition]#{enterprise}#
----
a| [.edition]#{enterprise}#

This text applies to Couchbase Server Enterprise Edition

a|
[source,asciidoc]
----
[.edition]#{community}#
----
a| [.edition]#{community}#

This text applies to Couchbase Server Community Edition

a|
[source,asciidoc]
----
[.status]#Couchbase Server x.x.x#
----
a| [.status]#Couchbase Server 7.6.2#

This text applies to Couchbase Server version 7.6.2

a|
[source,asciidoc]
----
[.deprecated]#Deprecated#
----
a| [.deprecated]#Deprecated#

This text applies to a deprecated feature

|====

=== Page Roles

Assigning a role to a page applies that role to the entire page, rather than a specific block or phrase.
Expand Down
2 changes: 1 addition & 1 deletion home/modules/contribute/partials/available-attributes.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ For a page in another repository: `:page-aliases:7.6@server:develop:integrations

When linking to a repository that has a version, you must specify which version in that repository redirects to your current page.

| `:page-edition:`
| [[page-edition]]`:page-edition:`
| If you're writing content that only applies to a specific edition of Couchbase Server, usually the Enterprise Edition, use the `page-edition` attribute to add a badge to the page that indicates the Edition the content applies to.
| `page-edition: Enterprise Edition`

Expand Down