Test PR for Vale/OpenAI #5
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
osfameron
commented
May 14, 2025
| @@ -1,3 +1,22 @@ | |||
| # 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.
Automated review comment from Vale and OpenAI:
Suggested change
| Note that this role does not grant the ability to back up or restore users. | |
| 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'.
osfameron
commented
May 14, 2025
| @@ -1,3 +1,22 @@ | |||
| # This is an example | |||
There was a problem hiding this comment.
Automated review comment from Vale and OpenAI:
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.
osfameron
commented
May 14, 2025
| @@ -1,3 +1,22 @@ | |||
| # 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.
Automated review comment from Vale and OpenAI:
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.
- Couchbase.DirectionalLanguage (warning) - Avoid directional language like 'up'.
There was a problem hiding this comment.
notice how on subsequent runs, the AI can give different answers.
osfameron
commented
May 14, 2025
|
|
||
| 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.
Automated review comment from Vale and OpenAI:
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'.
osfameron
commented
May 14, 2025
| * 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.
Automated review comment from Vale and OpenAI:
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:
- Couchbase.Semi-Colons (warning) - Try to avoid using a semi-colon. Follow the style guide guidance.
- Couchbase.Italics (error) - Don't use italics. Find another way to add emphasis.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Test PR that I've run docs-runner against (the diff and git wrangling are faked still, but the Vale -> OpenAI pipeline, and posting to Github are legit)