Repository navigation
ci(datalake): sync v2 docs into the team data lake - #332
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
✅ Mintlify HygieneNo issues found. |
Co-authored-by: capy-ai[bot] <230910855+capy-ai[bot]@users.noreply.github.com> Signed-off-by: SohamRatnaparkhi <92905626+SohamRatnaparkhi@users.noreply.github.com>
Co-authored-by: capy-ai[bot] <230910855+capy-ai[bot]@users.noreply.github.com> Signed-off-by: SohamRatnaparkhi <92905626+SohamRatnaparkhi@users.noreply.github.com>
bf57cf6 to
ac5bd73
Compare
✅ OpenHack SummarySecurity review of ci(datalake): sync v2 docs into the team data lake. 6 changed files; 0 findings at or above the low reporting threshold. Confidence Score: 5/5No reportable security findings were detected in this scan. Security merge-readiness rubric: 1 = critical, 2 = high, 3 = medium, 4 = low, 5 = no reportable findings. This score reflects scan findings, not a guarantee of correctness or complete coverage. Files Needing Attention: None Important Files Changed
Last reviewed commit: 827b237 · View review on OpenHack
|
[Medium impact] The PR appears safe to merge after the required SummaryAdds a separate sync that copies v2 public documentation into the team's data lake, with shared metadata and OpenAPI details.
|
Signed-off-by: SohamRatnaparkhi <92905626+SohamRatnaparkhi@users.noreply.github.com> Co-authored-by: capy-ai[bot] <230910855+capy-ai[bot]@users.noreply.github.com>
Adds
sync-datalake.yml, which keeps the public docs in the team's internal knowledge data lake (internal-knowledge-data-lake/common-collection). The Hydra MCP will search that database next to the internal wiki, Slack and Linear. It is separate from the website FAQ sync (sync-faq.yml): it uses a different database and a different secret, and the two syncs never touch each other's content.What gets ingested. Every page in the v2 navigation of
docs.json(Guides, Cookbooks, API Reference) becomes oneknowledge_basesource with idmdoc-<page>. v1 andarchive/are skipped. API reference MDX is mostly a stub, so the operation's parameters, body fields and responses are rendered fromopenapi.jsoninto the body.Metadata. These fields are shared with the internal wiki's sync, and
scripts/datalake_taxonomy.jsonmust stay identical to the copy in cortex-internal-docs:origin/audiencemintlify_docs/publicdoc_kindguide,plugin,cookbook,api_referenceproduct_arealifecycle/api_versionshipped/v2endpointPOST /query, from theopenapi:frontmattersection,path,ticketsPRO-xxxxids from the page's commitsRuns. Every triggered push to
mainand manual dispatch reconciles the full navigation, recovering any changes missed by a failed run. Each run then deletes data-lake sources this sync owns (filtered byorigin=mintlify_docsand themdoc-prefix) that have left the navigation. An unreadable page or a value outside the vocabulary aborts the run before it ingests or deletes anything.scripts/is gitignored, so the new files are force-added the same waysync_faq.pyis.Before merging: add the
HYDRADB_DATALAKE_API_KEYrepo secret.Verified with a full run: all 81 pages were indexed. Filtered queries for
audience=publicwithdoc_kind=api_reference,endpoint=POST /query, andproduct_area contains_any [metadata, retrieval]returned only matching pages.Need help on this PR? Tag
@codesmith-botwith what you need.