Skip to content

Test PR for Vale/OpenAI #5

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Test PR for Vale/OpenAI #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e4f1c74
add line
osfameron May 12, 2025
5035288
more updates
osfameron May 14, 2025
965980f
update test vale-review
osfameron May 14, 2025
df403b6
head.sha
osfameron May 14, 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
10 changes: 8 additions & 2 deletions .github/workflows/test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
name: Hakim testing

on:
workflow_dispatch:
pull_request:
paths:
# the following should match `path:` declaration below
- example/**

jobs:
vale:
uses: couchbaselabs/docs-runner/.github/workflows/vale-review.yml@main
with:
repo: ${{github.repository}}
path: example
pull_request_number: ${{ github.event.number }}
base_sha: ${{ github.event.pull_request.base.sha }}
head_sha: ${{ github.event.pull_request.head.sha }}
repository: ${{ github.repository }}
19 changes: 19 additions & 0 deletions example/modules/ROOT/pages/intro.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,22 @@
# This is an example
Copy link
Collaborator Author

@osfameron osfameron May 14, 2025

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:

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.

: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.
Copy link
Collaborator Author

@osfameron osfameron May 14, 2025

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:

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'.

Copy link
Collaborator Author

@osfameron osfameron May 14, 2025

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:

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'.

Copy link
Collaborator Author

@osfameron osfameron May 14, 2025

Choose a reason for hiding this comment

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

notice how on subsequent runs, the AI can give different answers.


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.
Copy link
Collaborator Author

@osfameron osfameron May 14, 2025

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:

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`)
|===

A list:

* 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_.
Copy link
Collaborator Author

@osfameron osfameron May 14, 2025

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:

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:

Loading