-
Notifications
You must be signed in to change notification settings - Fork 1
PR test for Vale Review #8
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
base: main
Are you sure you want to change the base?
Conversation
@@ -1,3 +1,32 @@ | |||
# This is an example |
There was a problem hiding this comment.
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:
# This is an example | |
# This Is An Example |
Using these Vale rules:
- Couchbase.Headings (warning) - 'This is an example' should use title-style capitalization.
@@ -1,3 +1,32 @@ | |||
# 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. |
There was a problem hiding this comment.
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:
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.
- Couchbase.DirectionalLanguage (warning) - Avoid directional language like 'up'.
|
||
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. |
There was a problem hiding this comment.
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:
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'.
* 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_. |
There was a problem hiding this comment.
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:
** 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:
- Couchbase.Italics (error) - Don't use italics. Find another way to add emphasis.
- Couchbase.Semi-Colons (warning) - Try to avoid using a semi-colon. Follow the style guide guidance.
** Users that are explicitly registered on Couchbase Server as _external_; as supported either by _LDAP_, _Security Assertion Markup Language (SAML)_, or _PAM_. | ||
|
||
Roles grant access to databases. | ||
It's important not to access the database directly. |
There was a problem hiding this comment.
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:
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'.
|
||
Roles grant access to databases. | ||
It's important not to access the database directly. | ||
Database access is great! |
There was a problem hiding this comment.
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:
Database access is great! | |
Database access is great. |
Using these Vale rules:
- Google.Exclamation (error) - Don't use exclamation points in text.
Roles grant access to databases. | ||
It's important not to access the database directly. | ||
Database access is great! | ||
Role based access controls are awesome! |
There was a problem hiding this comment.
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:
Role based access controls are awesome! | |
Role based access controls are awesome. |
Using these Vale rules:
- Google.Exclamation (error) - Don't use exclamation points in text.
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. |
There was a problem hiding this comment.
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:
NOTE: We recommend keeping residentRatio above 10 to avoid issues like index build failures. | |
NOTE: It is recommended to keep residentRatio above 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'?
- Google.WordList (warning) - Use 'preceding' or 'later' instead of 'above'.
- Couchbase.DirectionalLanguage (warning) - Avoid directional language like 'above'.
No description provided.