Skip to content

Conversation

@osfameron
Copy link
Collaborator

@osfameron osfameron commented May 15, 2025

Preview URL: (fake)
https://preview.docs-test.couchbase.com/docs-capella-DOC-12670

You will need the Docs Team credentials on Confluence.


Some other content we want to keep

@osfameron osfameron requested review from tech-comm-team-couchbase and removed request for tech-comm-team-couchbase May 16, 2025 10:59
@osfameron osfameron changed the title Test3 PR test for Vale Review May 20, 2025
@osfameron osfameron requested review from tech-comm-team-couchbase and removed request for tech-comm-team-couchbase June 26, 2025 08:37
@@ -1,7 +1,32 @@
= This is an example
# This is an example

Choose a reason for hiding this comment

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

Automated review comment from Vale and OpenAI using the gpt-4o-mini model:

Suggested change
# This is an example
# This Is An Example

Using these Vale rules:

  • Couchbase.Headings (warning) - 'This is an example' should use title-style capitalization.

Copy link
Contributor

Choose a reason for hiding this comment

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

"This Is An Example" is not title case. According to Wikipedia

When using title case, all words are capitalized, except for minor words (typically articles, short prepositions, and some conjunctions)

So "This is an Example" would be correct. "This Is An Example" is not.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Indeed. The docs bot is NOT trained on the style guide, so all it sees is "Couchbase.Headings (warning) - 'This is an example' should use title-style capitalization."

# This is an example
:description: pass:q[Roles grant users access to one or more resources.]

Note that this role does not grant the ability to back up or restore users.

Choose a reason for hiding this comment

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

Automated review comment from Vale and OpenAI using the gpt-4o-mini model:

Suggested change
Note that this role does not grant the ability to back up or restore users.
NOTE: This role does not grant the ability to back up or restore users.

Using these Vale rules:

  • Couchbase.NoteThat (error) - Don't use 'note that.' Convert to an actual NOTE, or don't use it at all.

Here is a test example.
A second line on this example.

This page is about what is so good about couchbase server. And about couchbase capella.

Choose a reason for hiding this comment

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

Automated review comment from Vale and OpenAI using the gpt-4o-mini model:

Suggested change
This page is about what is so good about couchbase server. And about couchbase capella.
This page is about what's so good about Couchbase Server.
And about Couchbase Capella.

Using these Vale rules:

  • Couchbase.Contractions (error) - Use 'what's' instead of 'what is'.
  • Vale.Terms (error) - Use 'Couchbase Server' instead of 'couchbase server'.
  • Couchbase.VentilatedProse (warning) - Use ventilated prose. Start every sentence on a new line.
  • Vale.Terms (error) - Use 'Couchbase' instead of 'couchbase'.
  • Vale.Terms (error) - Use 'Capella' instead of 'capella'.

[#table_backup_admin_role,cols="1,2,2,hrows=2"]
|===
5+^| Role: XDCR Admin (`replication_admin`)
3+^| Role: Backup Full Admin (`backup_admin`)

Choose a reason for hiding this comment

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

Automated review comment from Vale and OpenAI using the gpt-4o-mini model:

Suggested change
3+^| Role: Backup Full Admin (`backup_admin`)
3+^| Role: Backup Full Admin (`backup_admin`)

Using these Vale rules:

  • Couchbase.RepeatedSpace (error) - Did you mean to add extra spaces?

* of items
** like this
** and this
** Users that are explicitly registered on Couchbase Server as _external_; as supported either by _LDAP_, _Security Assertion Markup Language (SAML)_, or _PAM_.

Choose a reason for hiding this comment

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

Automated review comment from Vale and OpenAI using the gpt-4o-mini model:

Suggested change
** Users that are explicitly registered on Couchbase Server as _external_; as supported either by _LDAP_, _Security Assertion Markup Language (SAML)_, or _PAM_.
** Users that are explicitly registered on Couchbase Server as external, as supported either by LDAP, Security Assertion Markup Language (SAML), or PAM.

Using these Vale rules:

Adding a line for testing.
Roles grant access to databases.
It's important not to access the database directly.

Choose a reason for hiding this comment

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

Automated review comment from Vale and OpenAI using the gpt-4o-mini model:

Suggested change
It's important not to access the database directly.
It's important not to use the database directly.

Using these Vale rules:

  • Google.WordList (warning) - Use 'see', 'edit', 'find', 'use', or 'view' instead of 'to access'.

Adding a line for testing.
Roles grant access to databases.
It's important not to access the database directly.
Database access is great!

Choose a reason for hiding this comment

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

Automated review comment from Vale and OpenAI using the gpt-4o-mini model:

Suggested change
Database access is great!
Database access is great.

Using these Vale rules:

Roles grant access to databases.
It's important not to access the database directly.
Database access is great!
Role based access controls are awesome!

Choose a reason for hiding this comment

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

Automated review comment from Vale and OpenAI using the gpt-4o-mini model:

Suggested change
Role based access controls are awesome!
Role based access controls are awesome.

Using these Vale rules:

Look at xref:couchbase.adoc[] for more information about Couchbase Server.
She sells seashells by the seashore.

NOTE: We recommend keeping residentRatio above 10 to avoid issues like index build failures.

Choose a reason for hiding this comment

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

Automated review comment from Vale and OpenAI using the gpt-4o-mini model:

Suggested change
NOTE: We recommend keeping residentRatio above 10 to avoid issues like index build failures.
NOTE: It's recommended to keep residentRatio later 10 to avoid issues like index build failures.

Using these Vale rules:

  • Google.We (warning) - Try to avoid using first-person plural like 'We'.
  • Vale.Spelling (error) - Did you really mean 'residentRatio'?
  • Couchbase.DirectionalLanguage (warning) - Avoid directional language like 'above'.
  • Google.WordList (warning) - Use 'preceding' or 'later' instead of 'above'.

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.

4 participants