Cite external upstreams instead of the internal research/ tree#425
Open
xmap wants to merge 1 commit into
Open
Conversation
…search/ tree The research/ tree is now local-only and gitignored (#420/#421): it is the developer's private upstream practice, not shared. But tracked, public deployment pages still linked into it with github.com/.../research/... URLs that 404 now that research/ is out of the repo, and the NSRRC research brief still lived in the published docs tree. Both leak private research into the public site. Fix the leak by citing the real external upstream the descriptor was reverse-engineered from, and dropping the internal research/ pointer: - APS beamlines (4-ID/8-ID/9-ID) -> the BCDA-APS/*-bits instrument repos - ESRF beamlines (ID19/ID16B) -> the gitlab.esrf.fr Beacon configs - SYRMEP/FAXTOR -> the elettra.eu / cells.es facility pages - Remove docs/deployments/nsrrc/_research_brief.md from the published tree and scrub its inbound links (the TPS pages + deployments index); the brief is preserved locally under the gitignored research/nsrrc/. - Point scripts/reverse_engineer defaults at research/aps/ (the canonical local layout) instead of the old research/aps-reverse-engineering/ path. No public page references research/ any more. Deployment tests (541) pass and mkdocs --strict builds with no orphan-page or broken-link regressions. Co-Authored-By: Claude <noreply@anthropic.com>
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
1 participant
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.
Summary
research/is now local-only and gitignored (per merged #420/#421) — the developer's private upstream practice, not shared. But tracked public pages still linked into it withgithub.com/xmap/cora/.../research/...URLs that now 404, and the NSRRC research brief still lived in the published docs tree. Both leak private research into the public site. This fixes the leak by citing the real external upstream each descriptor was reverse-engineered from.BCDA-APS/*-bitsinstrument repos.gitlab.esrf.fr/<bl>/beamline_configurationBeacon configs.elettra.eu/cells.esfacility pages.docs/deployments/nsrrc/_research_brief.mdfrom the published tree and scrub its inbound links (TPS-05A/07A pages + the deployments index). The brief is preserved locally under the gitignoredresearch/nsrrc/.scripts/reverse_engineerdefaults atresearch/aps/(the canonical local layout) instead of the oldresearch/aps-reverse-engineering/.After this, no public page references
research/.Context
Supersedes the closed #422 (which tried to make
research/a tracked tree — the opposite of the local-only direction main settled on). The disciplined two-tier research structure from #422 is preserved on-disk locally, gitignored.Test plan
pytest tests/unit/deployments/— 541 passedmake docs-build(mkdocs--strict) — exit 0, no orphan-page or broken-link regressionsgit grepconfirms zeroresearch/path references in tracked files (only the.gitignorerule remains)🤖 Generated with Claude Code