Skip to content

RDBTC-266 Guide: Powerful CI with Test Driver & Testcontainers - #2708

Open
Netzach-Nyss wants to merge 2 commits into
ravendb:mainfrom
Netzach-Nyss:RDBTC-266
Open

Netzach-Nyss wants to merge 2 commits into
ravendb:mainfrom
Netzach-Nyss:RDBTC-266

Conversation

@Netzach-Nyss

Copy link
Copy Markdown
Contributor

Issue link

RDBTC-266 Guide: Powerful CI with Test Driver & testcontainers

Additional description

Content Quality Score: 84/100 (was 80)

Factor Score Key Signals
Experience 22/25 Original screenshots, real tracebacks and timings, and a pull request that actually fails
Expertise 23/25 The workflow now works with the repository layout, and the action versions, license terms and pins are confirmed
Authoritativeness 18/25 The Python Test Driver guide now links here. There's still no sample repo
Trustworthiness 21/25 pip install now resolves with the pinned versions. Some code the reader needs is still missing

AI Citation Readiness: 77/100 (was 72). RavenDB, pytest, Testcontainers and GitHub Actions are all named in the first paragraph now. The guide still has no table or short list that an AI tool could quote.

Metrics: about 3,850 words of prose. The description is 155 characters. There are no em dashes or curly quotes, all alt text is descriptive, and the author is in authors.json.

Issues found

  1. There's no sample repo, and some code is missing (biggest gap). Line 281 still says "The repository also has its twin", but nothing is linked. A reader also never sees:

    • domain.py, FakeStore and place_order
    • the imports for NOW, Book, Order, OrderService and timedelta

    A beginner can't put the suite together. This one needs you: publish the bookshop repo and link it, or add the missing code to the guide.

  2. Few internal links. 7 links in about 3,850 words is 1.8 per 1,000, under the 3 to 5 target. These pages all exist:

    • wait_for_indexes_after_save_changes (line 411) → /7.2/client-api/session/saving-changes, which has a "Waiting for Indexes" section with the Python example
    • "tag of the cluster node" (line 353) → /7.2/glossary/node-tag
    • "RavenDB's official image" (line 166) → /7.2/start/containers/general-guide
  3. Nothing compact to quote. The three behaviours a mock hides (dates come back as text, ids carry a node tag, indexing is asynchronous) are spread across three sections. A small table at the start of "Tests a mock could never write", with columns for what the mock returns, what RavenDB returns and what it breaks, would give AI tools something to quote. It would also give readers a quick summary.

  4. The recorded output is from before the pin change. The guide now pins 7.2.6.post1, but the traceback line numbers, "4 passed… in 6.90s" and the screenshots come from the earlier setup. Run the suite once with the new pins to confirm they still match. I can't do this here because the bookshop code isn't in this repo.

Type of change

  • Content - docs
  • Content - cloud
  • Content - Quill
  • Content - guides
  • Content - start pages/other
  • New docs feature (consider updating /templates or readme)
  • Bug fix
  • Optimization
  • Other

Changes in docs URLs

  • No changes in docs URLs
  • Articles are restructured, URLs will change, mapping is required (update /scripts/redirects.json file, set Documents Moved PR label)

Changes in UX/UI

  • No changes in UX/UI
  • Changes in UX/UI (include screenshots and description)

@poissoncorp

Copy link
Copy Markdown
Contributor

There's no sample repo, and some code is missing (biggest gap). <- can you create a gist and link to it?

@poissoncorp

Copy link
Copy Markdown
Contributor

also fix "Few internal links. 7 links in about 3,850 words is 1.8 per 1,000, under the 3 to 5 target. These pages all exist" and other issues pointed out

@poissoncorp

Copy link
Copy Markdown
Contributor

@Netzach-Nyss ^

…comparison table

- Link the bookshop sample gist and require Python 3.11+
- Pin ravendb and ravendb-test-driver to 7.2.7, matching the server image
- Add internal links and a mock vs. RavenDB comparison table
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.

2 participants