Skip to content

RDBTC-221 Migrate technical guides Migrating RDBTC-62 - #2634

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

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

Conversation

@Netzach-Nyss

Copy link
Copy Markdown
Contributor

Issue link

RDBTC-62 Performing Backup & Restore using the API with the Node.JS RavenDB client
RDBTC-221 Migrate technical guides and how-tos from ravend.net/articles to docs.ravendb.net/guides

Additional description

Content Quality & E-E-A-T Analysis (re-run)

Target: programmatic-backup-and-restore-operations-in-ravendb-with-node-js.mdx
Context: second pass, after fixes 2, 3, 4, 6, 8, 9, 10 landed.

Content Quality Score: 74/100 (was 58)

Metrics

Metric Before Now Assessment
Total words incl. code 2,594 2,860 Comfortably above the 1,500 floor
Narrative prose (tables excluded) 1,766 1,434 Prose shrank as bullets became table rows, which is the right trade
Tables / table rows 0 8 / 47 Major structural gain
Headings 16 16 Clean H2/H3, no level skips
Code fences 8 js + 1 bash 8 ts + 1 bash Now honestly labeled
External links 3 6 Doubled, and now includes the client itself
Cross-links to other guides 0 0 Still zero
Images 0 0 Still zero
Avg sentence length 15.6 18.7 Unchanged in reality, see note
Flesch Reading Ease 17.5 19.9 Marginally easier
Flesch-Kincaid Grade 14.7 15.1 Fine for the audience
Published 2024-07-29 2024-07-29 ~25 months, no update marker

A note on the readability shift, since it looks like a regression and is not one. The first pass measured 15.6 words per sentence because ~40 short bullet fragments were being counted as sentences and dragging the mean down. With those now in tables and excluded from the sentence pool, 18.7 is the true figure for the narrative, and it was always the true figure. Both readings sit inside the 15-20 target band.

E-E-A-T Breakdown

Factor Score Change Key Signals
Experience 11/25 +1 Still no screenshots, run output, timings, or case study. The one gain: the new inline comments on delayUntil and nextBackup semantics read as earned knowledge rather than API paraphrase.
Expertise 20/25 +5 Code now runs as labeled, the two example defects are gone, the field reference is complete, and the GetPeriodicBackupStatusOperationResult wrapper is named precisely. The remaining 5 points are gated on author credentials.
Authoritativeness 15/25 +4 6 outbound links now, including npm, the client repo, and the client API reference. Still no Person node in the JSON-LD, and still zero links to sibling guides, so the page sits outside any topical cluster.
Trustworthiness 18/25 +2 Copy-pasteable code that parses is itself a trust signal. Still no author identity and no dateModified beyond the datePublished fallback.

Total: 64/100 (was 52)

AI Citation Readiness: 78/100 (was 62)

The 8 tables are the single largest gain. 47 rows of field | type | description are close to ideal extraction targets for AI Mode and Perplexity, far better than the loose bullets they replaced. The ## Summary bullets give four quotable, self-contained statements naming the exact operation classes, which is what gets lifted into a generated answer.

Still holding it back: the schema ships without an author, the opening 30 words answer nothing, and there is no FAQ block for the questions this topic actually attracts ("how do I back up RavenDB to S3 from Node.js", "how do I restore a RavenDB database programmatically").

Issues Found

High

  1. Author still not registered, schema still has no author node. author: "Lev Skuditsky" (line 21) returns 0 matches in docs/authors.json. DocPageMetadata.tsx:100 spreads author conditionally on authorInfo, so this page's TechArticle still ships with no author, jobTitle, or worksFor. Unchanged from the first pass, and now the largest single item, since the code-quality issues that previously shared the top slot are resolved.

Medium

  1. Zero cross-links, and a sibling guide is sitting right there. backups-in-ravendb.mdx covers the same domain from the conceptual and C#/Studio angle (logical vs snapshot, scheduled and server-wide tasks) and is far fresher, published 2026-04-14. Neither guide links to the other. This is the clearest topical-cluster pairing in the guides directory and both pages are losing authority by staying isolated. 10 other guides already use the ./slug cross-link pattern, so the convention exists. This one is new to the list, promoted from the first pass's issue 10 now that the external links are fixed.

  2. No image: in frontmatter and no inline images. Unchanged. The TechArticle schema declares a 1200x630 ImageObject at DocPageMetadata.tsx:89, so the page falls back to a site-generic OG image. Also the main thing still pinning Experience at 11/25.

  3. "RavenDB" missing from the title. Line 2 is still "Programmatic Backup and Restore with Node.js". 57 of 76 guide titles carry the brand.

  4. Opening 30 words still answer nothing. Line 32 opens on RavenDB's documentation strategy. The mismatch is now sharper than it was: the body is precise and well-structured, and the first paragraph reads like it belongs to a different document.

  5. proficiency_level: "Beginner" no longer matches the content. With 47 rows of typed field reference and TypeScript examples using tuple types and optional chaining, this reads as Expert. The frontmatter is a filtering signal on the guides hub, so a mismatch sends the wrong readers here. New observation, surfaced by the restructure.

Low

  1. Stale without an update marker. Published 2024-07-29, no last_updated. DocPageMetadata.tsx:92 falls back to datePublished for dateModified, so the schema asserts the page has not been touched in 25 months, which is now flatly untrue.

  2. Restore parameter list is the last bullet holdout. Lines 118-130 still use the * **field** (type): desc form while the other 8 field lists are tables. Left out of scope deliberately last round; it now looks inconsistent.

Recommendations

  1. Add "Lev Skuditsky" to docs/authors.json. One object, restores the Person node, closes the biggest remaining E-E-A-T and GEO gap. Worth batching with the other 6 unregistered authors.
  2. Cross-link with backups-in-ravendb.mdx in both directions using ./slug. Frame this guide as the Node.js/programmatic path and that one as the concepts-and-Studio path. Cheap, and it builds the cluster both pages currently lack.
  3. Rewrite the opener to answer-first and put "RavenDB" back in the title. These two are a single 10-minute edit and they fix the weakest-looking part of an otherwise strong page.
  4. Add an image: plus one Studio screenshot of the backup task view. Highest-leverage move for the Experience score, which is now the clear laggard at 11/25.
  5. Change proficiency_level to "Expert" to match what the guide actually is.
  6. Convert the restore parameter list to a table for consistency with the other 8, and add a last_updated marker once the above lands.

Verified as fixed since the first pass: all 8 code fences tagged ts and consistent with their contents; nextBackup reads from myBackup.nextBackup?.dateTime; upload destinations are name/status pairs and log real destination names; ## Summary replaces ## Conclusion with 4 plain-text bullets; 8 field lists converted to tables; lastFullBackup and lastIncrementalBackup documented; the status wrapper explained accurately; npm, client repo, and API reference linked. The file compiles under @mdx-js/mdx with remark-gfm.

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