Skip to content

DOCSP-49937: Remove legacy build toolchain instructions - #192

Closed
emetozar wants to merge 1 commit into
masterfrom
DOCSP-49937-remove-legacy-build-tools
Closed

DOCSP-49937: Remove legacy build toolchain instructions#192
emetozar wants to merge 1 commit into
masterfrom
DOCSP-49937-remove-legacy-build-tools

Conversation

@emetozar

Copy link
Copy Markdown

Jira

https://jira.mongodb.org/browse/DOCSP-49937

Summary

All docs built off the legacy Giza/Sphinx toolchain have been archived, so the build tool install page is no longer relevant.

  • Delete source/tutorials/install.txt (Installing MongoDB Documentation Build Tools)
  • Delete source/includes/steps-install.yaml, the steps file it included
  • Remove /tutorials/install from the Tutorials toctree
  • Remove the "Install Build Tools" step from steps-repo.yaml, which was the only remaining inbound :doc: reference

No dangling references to the removed page remain.

Note

No redirect was added — config/redirects currently has no entries and the page was noindex, nosnippet. Happy to add one if the team wants /docs/meta/tutorials/install pointed somewhere.

@netlify

netlify Bot commented Jul 29, 2026

Copy link
Copy Markdown

Deploy Preview for mongodb-docs-meta failed. Why did it fail? →

Name Link
🔨 Latest commit 23e201d
🔍 Latest deploy log https://app.netlify.com/projects/mongodb-docs-meta/deploys/6a6a1c3c4c93590008dc4de1

@docs-builder-bot

docs-builder-bot commented Jul 29, 2026

Copy link
Copy Markdown

🔄 Deploy Preview for mongodb-docs-meta processing

Item Details
🔨 Latest Commit 22b38441850c62351462fa4073318b949fd3d773
😎 Deploy Preview https://deploy-preview-192--mongodb-docs-meta.netlify.app/docs/meta
🔍 Build Logs View Logs

The legacy Giza/Sphinx toolchain docs have been archived, so remove the
build tool install page, its steps file, the toctree entry, and the
Install Build Tools step in the repo setup tutorial.
@emetozar
emetozar force-pushed the DOCSP-49937-remove-legacy-build-tools branch from abfebae to 23e201d Compare July 29, 2026 15:28
@emetozar

Copy link
Copy Markdown
Author

Closing this — wrong repo. This repo is deprecated and content changes belong in the monorepo, under content/meta/.

Redone as https://github.com/10gen/docs-mongodb-internal/pull/22485, which also picks up two things that don't exist here: the unified ToC entry and the legacy meta sidenav ToC (in both platform app copies), plus a redirect for the removed URL.

For anyone who finds this later: the deploy preview failures on this PR were not caused by the change. The build died in onPreBuild inside the populate-metadata extension at buildUnifiedTOC with spawn npm ENOENT, before the parser ever read the source. The last successful deploy on this site was June 2025, matching master's last commit.

@emetozar emetozar closed this Jul 29, 2026
@emetozar
emetozar deleted the DOCSP-49937-remove-legacy-build-tools branch July 29, 2026 17:07
mongodb-server-docs-sync-bot Bot pushed a commit to mongodb/docs that referenced this pull request Jul 29, 2026
…a (#22485)

## DESCRIPTION

All docs built off the legacy Giza/Sphinx toolchain have been archived,
so the build tool install page is no longer relevant. This removes the
page and everything that pointed at it.

Content (`content/meta/`):

- Delete `source/tutorials/install.txt` (Installing MongoDB
Documentation Build Tools)
- Delete `source/includes/steps-install.yaml`, the steps file it
included; not referenced anywhere else
- Remove `/tutorials/install` from the Tutorials toctree in
`source/tutorials.txt`
- Remove the "Install Build Tools" step from
`source/includes/steps-repo.yaml`, which was the only remaining inbound
`:doc:` reference
- Add a redirect in `netlify.toml`: `/docs/meta/tutorials/install/` ->
`/docs/meta/tutorials/`

Unified ToC (per the `unified-toc` skill):

- `content/table-of-contents/docset-data/meta.ts` — removed the entry
- `platform/docs-site/.../legacy-docs/meta-main.ts` and
`platform/docs-nextjs/.../legacy-docs/meta-main.ts` — removed the entry
from both copies

Worth a reviewer's eye: `meta` is listed in `legacyTocProjects` in
`unified-toc-context.tsx`, so the meta sidenav renders from
`legacy-docs/meta-main.ts` rather than from `docset-data/meta.ts`.
Updating only docset-data would have left a dead link in the live
sidenav, so both are updated. No `isExternal` symlinks to this page
exist in the ToC. `pnpm tsc --noEmit` passes in
`content/table-of-contents`.

Out of scope, flagging rather than changing:

- `./lint-docs.sh all` reports 2 errors + 2 warnings on
`source/tutorials.txt` (short title, missing meta description, short H1,
low content). All four pre-exist on `main` — verified by stashing and
re-running. The only delta is the page word count, 13 -> 12, from
removing one toctree line.
- Several `content/manual/*/CONTRIBUTING.rst` and
`content/ruby-driver/*/README.rst` files link to the old URL as an
external link. The redirect above keeps those resolving. Some are EOL
versions, so I left them alone.
- The pre-commit hook regenerated 6 unrelated `offline-docs` files
(atlas-architecture, ops-manager, development) from pre-existing
docset-data drift on `main`. `meta` appears in zero offline-docs files,
so none of it relates to this change and I dropped it from the commit.
Someone may want to regenerate those separately.

Supersedes mongodb/docs-meta#192, which I opened against the deprecated
standalone repo before learning content changes belong here.

## STAGING

Pending cloud build.

## JIRA

https://jira.mongodb.org/browse/DOCSP-49937

## SELF-REVIEW CHECKLIST

- [ ] Does each file have 3-5 taxonomy facet tags? (n/a — deletion only,
no new pages)
- [x] Is this free of any warnings or errors in the RST?
- [x] Is this free of spelling errors?
- [x] Is this free of grammatical errors?
- [ ] Is this free of staging / rendering issues?
- [x] Are all the links working?
- [ ] If this documents a server feature and is presented in any
downstream product teams, have you reached out to writers on those
teams? (n/a)
- [ ] Is there a public preview/GA requirement for this content change?
(n/a)
- [ ] For features gated by server version, confirm a DRI has reviewed
this text. (n/a)

## EXTERNAL REVIEW REQUIREMENTS

[What's expected of an external
reviewer?](https://wiki.corp.mongodb.com/display/DE/Reviewing+Guidelines+for+the+MongoDB+Server+Documentation)
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.

2 participants