Repository navigation
Reduce the owner and support pages to stubs - #213
Merged
Merged
Conversation
Follows autofac/.github#2, which moved the owner's guide into MAINTAINERS.md in the organization repository. Both pages now point there instead of holding a second copy, in the same shape as the contributor page, which has worked this way for a while. Keeping stubs rather than deleting the files preserves owners.html and support.html, so existing links and bookmarks still land somewhere useful. The troubleshooting page also links to the support page, and that reference keeps working. The support stub keeps two things rather than being a pure redirect: which repository to file an issue in, since filing in core Autofac for an integration problem is the most common mistake, and what a useful report contains. The longer version of the latter is redundant with the issue templates, which ask for a reproduction, the whole exception with stack trace, and dependency versions. Removing 220 lines of owner guidance and 19 lines of support content from the documentation site drops nothing that isn't now in the organization repository - the content moved in that pull request rather than being rewritten, and every link in these stubs was verified against the API to resolve.
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.
Follows autofac/.github#2, now that
MAINTAINERS.mdexists onmain. −231 lines.What changed
Both pages now point at the organization repository instead of holding a second copy, in the same shape as
contributors.rst, which has worked this way for a while.Stubs rather than deletions, deliberately:
owners.htmlandsupport.htmlkeep resolving, so existing links and bookmarks land somewhere useful.troubleshooting/index.rstalso links to the support page, and that reference keeps working.What the support stub keeps
Not a pure redirect. Two things are worth saying on the docs site itself:
Nothing lost
The 220 lines of owner guidance moved in .github#2 rather than being rewritten — I ran a word-level parity check there, 512 of 533 distinctive words carried over, with every drop accounted for. Every link in these stubs was verified against the API:
MAINTAINERS.md,CODE_OF_CONDUCT.md,SUPPORT.md,CONTRIBUTING.md, and theAutofac.WebApiissues link all resolve.A find along the way
Checking whether the issue templates covered the reporting advice turned up a separate defect: the bug report template linked to a page that doesn't exist.
advanced/debugging.htmlwas deleted from this repo years ago in the exception-docs reorganization — traced it to95b1e73(added) and7cb8e08(removed). So everyone filing a bug has been shown a 404 in the one place we ask them to read the diagnostics docs first. Fixed separately in autofac/.github#3.Verification
sphinx -W,doc8,pre-commit,npm run lintclean. Nested-markup and bad-link scans clean. Confirmed both pages still build and render, and that the inbound:doc:reference from the troubleshooting page still resolves — the-Wbuild would have failed if it didn't.