Skip to content

RDBTC-221 Migrate technical guides Migrating RDBTC-64 - #2630

Open
Netzach-Nyss wants to merge 1 commit into
ravendb:mainfrom
Netzach-Nyss:RDBTC-64
Open

RDBTC-221 Migrate technical guides Migrating RDBTC-64#2630
Netzach-Nyss wants to merge 1 commit into
ravendb:mainfrom
Netzach-Nyss:RDBTC-64

Conversation

@Netzach-Nyss

Copy link
Copy Markdown
Contributor

Issue link

RDBTC-64 OpenTelemetry - Grafana Cloud configuration
RDBTC-221 Migrate technical guides and how-tos from ravend.net/articles to docs.ravendb.net/guides

Additional description

Content Quality Score: 78/100 (was 76, 64 at baseline)

File: grafana-cloud-configuration-with-opentelemetry.mdx
1,433 words total (1,123 prose) · 11 images, 11 with alt · 4 in-body internal links · 5/5 fences tagged · 0 tables


E-E-A-T Breakdown

Factor Score Key Signals
Experience 18/25 (=) ✅ 11 original screenshots · ✅ Specific metric name and config keys · ✅ First-hand gotcha on the one-minute export interval · ❌ No version tested, no failure narrative, no outcome
Expertise 20/25 (=) ✅ Cloud facts correct and sourced · ✅ Config keys linked to reference · ❌ No author bio link · ⚠️ proficiency_level looks miscalibrated (below)
Authoritativeness 18/25 (+1) ✅ Both prerequisite links now point at real resources · ✅ 4 internal links, sibling-guide cluster · ❌ Still zero third-party citations (no OTel spec, no Grafana OTLP reference)
Trustworthiness 20/25 (+1) ✅ Stale "coming soon" promise gone · ✅ Facts corrected and sourced · ❌ No updated-date mechanism (declined; schema lacks the field) · ❌ Author avatar is a placeholder, profile url is null

Total: 76/100 (was 60 at baseline)

Readability: Flesch 58.9, grade 8.4, avg sentence 13.5 words

Trend across the three passes: 60.6 → 59.1 → 58.9. A slow drift just below the 60-70 band, caused by my own additions, which are denser than the surrounding prose. Not worth reversing, but it is drift in one direction and worth knowing.

Correction on my own measurement: the first figure I computed this pass was 56.2, which I reported to myself using a different text-stripping pipeline than passes 1 and 2. That number was not comparable. 58.9 above is the like-for-like figure.

Keyword Optimization: Healthy

ravendb 1.83%, grafana 1.83%, opentelemetry 1.16%. All inside the natural 1-3% band, no stuffing. Title 72 chars (will truncate slightly in SERPs, acceptable). Description 139 chars, well within range.

AI Citation Readiness: 68/100 (was 52 at baseline)

Unchanged structurally since last pass. The two gaps that cap this number are still the missing table and the missing answer-first opener.


Issues Found

New this pass

  1. proficiency_level: "Expert" looks wrong. The content is click-through UI instruction: create an account, paste four config keys, pick a metric from a dropdown, set a unit. Your sibling guide sending-your-ravendb-7-0-logs-to-grafana-cloud.mdx:21 is same author, same platform, comparable difficulty, and is labeled "Beginner". A reader arriving expecting expert-level material gets a walkthrough, which is exactly the expectation mismatch that produces pogo-sticking. Repo-wide the split is 50 Expert to 26 Beginner, so this may be a broader calibration drift rather than a one-file slip.

  2. Four paragraphs run 6 to 9 sentences, against the 2-4 guideline. The worst is the 9-sentence, 99-word block at line 129, which buries the genuinely useful "RavenDB sends OpenTelemetry data once a minute, so you need to be patient" at the very end. That sentence is the single most citable original observation on the page and it is currently unfindable. One of the other three is the Cloud availability block I wrote, so I own that one.

Carried forward, unchanged

  1. No config table. Still the highest-leverage missing element.
  2. No answer-first opener; line 40 still opens on "often much appreciated" and lands on "pretty dashboards."
  3. Config still five fragments rather than one complete settings.json.
  4. Author record thin in docs/authors.json (url: null, placeholder avatar).
  5. No third-party authoritative citations.

Declined, recorded: RavenDB version not stated, word count below the 1,500 floor.


Recommendations

Worth saying plainly: this file has converged. Three passes have now produced the same two top items, and a fourth pass without acting on them will return this list again rather than new information.

Ranked by remaining yield:

  1. Config reference table (+6 to +8 citation readiness, fixes issues 3 and 5)
  2. Answer-first opener (+4)
  3. Split the 9-sentence paragraph and surface the one-minute-interval fact as its own line or admonition. Cheap, and it promotes your best original observation into something quotable.
  4. Resolve the proficiency level. A judgment call I should not make for you, but Beginner matches both the content and your own sibling guide.

Items 1-3 add prose without editing existing prose, so the voice is untouched. Item 4 is a one-word frontmatter change.

Want me to draft 1, 2, and 3 for review? On item 4, I would rather you decide than have me flip it.

Two things still outstanding from earlier passes, neither of which I have acted on: the two external ravendb.net/articles/... links pointing back at this guide from cloud/cloud-features.mdx:184 and docs/monitoring/integrations/open-telemetry.mdx:8, and the fact that I have never run a build, so the /7.2/ links are verified as files but not as routes.

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)

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.

1 participant