Repository navigation
RDBTC-266 Guide: Powerful CI with Test Driver & Testcontainers - #2708
Open
Netzach-Nyss wants to merge 2 commits into
Open
Netzach-Nyss wants to merge 2 commits into
Netzach-Nyss wants to merge 2 commits into
Conversation
Contributor
|
There's no sample repo, and some code is missing (biggest gap). <- can you create a gist and link to it? |
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 |
Contributor
…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
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
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.
Issue link
RDBTC-266 Guide: Powerful CI with Test Driver & testcontainers
Additional description
Content Quality Score: 84/100 (was 80)
pip installnow resolves with the pinned versions. Some code the reader needs is still missingAI 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
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,FakeStoreandplace_orderNOW,Book,Order,OrderServiceandtimedeltaA 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.
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/7.2/glossary/node-tag/7.2/start/containers/general-guideNothing 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.
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
/templatesor readme)Changes in docs URLs
/scripts/redirects.jsonfile, setDocuments MovedPR label)Changes in UX/UI