QRun-IO/qbit-quick-search
3
0 Fork 0
Code Issues 2 Pull Requests 4 Actions Packages Projects Releases 14 Wiki Activity

Fix migration guide and README gaps found adopting RC.2 #26

New Issue
Closed
opened 2026-10-09 23:20:23 +00:00 by KofTwentyTwo · 0 comments
KofTwentyTwo commented 2026-10-09 23:20:23 +00:00 (Migrated from github.com)
Copy link
Copy source

The qqq-all adoption of 1.0.0-RC.2 (QRun-IO/qqq-all#30) found no defects but four documentation gaps:

  1. docs/MIGRATION-1.0.md says to grant permissions but never names them. It should list quickSearchAdmin.hasAccess plus .read/.write on quickSearchIndex, quickSearchIndexRun and quickSearchFailedEvent.
  2. The guide has no schema section. 1.0 adds five quickSearchIndex columns and the quickSearchFailedEvent table, and hosts with a startup column check reject 0.x tables. It needs the DDL changes, or a pointer to them.
  3. The guide writes allowPlaintextCredentials(true); the real method is withAllowPlaintextCredentials.
  4. The README badge and dependency snippet still say 1.0.0-RC.1.

Part of #12.

The qqq-all adoption of `1.0.0-RC.2` (QRun-IO/qqq-all#30) found no defects but four documentation gaps: 1. `docs/MIGRATION-1.0.md` says to grant permissions but never names them. It should list `quickSearchAdmin.hasAccess` plus `.read`/`.write` on `quickSearchIndex`, `quickSearchIndexRun` and `quickSearchFailedEvent`. 2. The guide has no schema section. 1.0 adds five `quickSearchIndex` columns and the `quickSearchFailedEvent` table, and hosts with a startup column check reject 0.x tables. It needs the DDL changes, or a pointer to them. 3. The guide writes `allowPlaintextCredentials(true)`; the real method is `withAllowPlaintextCredentials`. 4. The README badge and dependency snippet still say `1.0.0-RC.1`. Part of #12.
Sign in to join this conversation.
No Branch/Tag Specified
Labels
Clear labels
architecture
Architecture review: coupling, cohesion, UI API
 bug
Something isn't working
 dependencies
documentation
Improvements or additions to documentation
 duplicate
This issue or pull request already exists
 enhancement
New feature or request
 github_actions
Pull requests that update GitHub Actions code
 good first issue
Good for newcomers
 help wanted
Extra attention is needed
 invalid
This doesn't seem right
 java
Pull requests that update java code
 question
Further information is requested
 release:rc
Merging this develop PR cuts the next release candidate
 secuurity
wontfix
This will not be worked on
No labels
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
forge-recovery (Forge Recovery) james.maes (James Maes)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: QRun-IO/qbit-quick-search#26