RDBTC-221 Migrate technical guides Migrating RDBTC-62 - #2634
Open
Netzach-Nyss wants to merge 1 commit into
Open
Conversation
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-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
js+ 1bashts+ 1bashA 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
delayUntilandnextBackupsemantics read as earned knowledge rather than API paraphrase.GetPeriodicBackupStatusOperationResultwrapper is named precisely. The remaining 5 points are gated on author credentials.Personnode in the JSON-LD, and still zero links to sibling guides, so the page sits outside any topical cluster.dateModifiedbeyond thedatePublishedfallback.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 | descriptionare close to ideal extraction targets for AI Mode and Perplexity, far better than the loose bullets they replaced. The## Summarybullets 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
author: "Lev Skuditsky"(line 21) returns 0 matches indocs/authors.json. DocPageMetadata.tsx:100 spreadsauthorconditionally onauthorInfo, so this page'sTechArticlestill ships with noauthor,jobTitle, orworksFor. 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
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
./slugcross-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.No
image:in frontmatter and no inline images. Unchanged. TheTechArticleschema declares a 1200x630ImageObjectat DocPageMetadata.tsx:89, so the page falls back to a site-generic OG image. Also the main thing still pinning Experience at 11/25."RavenDB" missing from the title. Line 2 is still "Programmatic Backup and Restore with Node.js". 57 of 76 guide titles carry the brand.
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.
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
Stale without an update marker. Published 2024-07-29, no
last_updated. DocPageMetadata.tsx:92 falls back todatePublishedfordateModified, so the schema asserts the page has not been touched in 25 months, which is now flatly untrue.Restore parameter list is the last bullet holdout. Lines 118-130 still use the
* **field** (type): descform while the other 8 field lists are tables. Left out of scope deliberately last round; it now looks inconsistent.Recommendations
"Lev Skuditsky"todocs/authors.json. One object, restores thePersonnode, closes the biggest remaining E-E-A-T and GEO gap. Worth batching with the other 6 unregistered authors../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.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.proficiency_levelto"Expert"to match what the guide actually is.last_updatedmarker once the above lands.Verified as fixed since the first pass: all 8 code fences tagged
tsand consistent with their contents;nextBackupreads frommyBackup.nextBackup?.dateTime; upload destinations are name/status pairs and log real destination names;## Summaryreplaces## Conclusionwith 4 plain-text bullets; 8 field lists converted to tables;lastFullBackupandlastIncrementalBackupdocumented; thestatuswrapper explained accurately; npm, client repo, and API reference linked. The file compiles under@mdx-js/mdxwithremark-gfm.Type of change
/templatesor readme)Changes in docs URLs
/scripts/redirects.jsonfile, setDocuments MovedPR label)Changes in UX/UI