Repository navigation
SOLR-18577: Fix dead links and stale workflow content in the contributor docs - #5212
Open
nick-boss-tech wants to merge 17 commits into
Open
nick-boss-tech wants to merge 17 commits into
nick-boss-tech wants to merge 17 commits into
Conversation
… ASF email tips page
…tory it linked no longer exists
…h the MARC archive link
…bsolute beginners
…; use ./gradlew in the frontend answer
…agments live at the repository root
…intainer approval
epugh
reviewed
Oct 23, 2026
epugh
approved these changes
Oct 23, 2026
epugh
left a comment
Contributor
There was a problem hiding this comment.
LGTM. One tiny nit on email services, but this is a nice clean up.
Contributor
|
i think the direct to slack at least conveys "hey, there is a slack community". and no one uses irc these days as far as i know. Or maybe I should say, I deefinitly dont! |
Link directly to the cited message in the ASF mailing-list archive instead of the MARC archive. This addresses the review nit while keeping the reference specific to the original email.
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.
🤖 AI text below 🤖 (posted on behalf of Nick Shanin)
https://issues.apache.org/jira/browse/SOLR-18577
What happens today
Seven references in the contributor-facing docs and one javadoc are dead, and several workflow statements in the same docs no longer match the build or the repository.
The Slack sign-up address https://s.apache.org/solr-slack appears in CONTRIBUTING.md, README.md, solr/packaging/README.txt and the admin UI (index.html). It redirects to a Community Inviter page that answers 404: the invite service has shut down, and its successor service has no page for the workspace.
Also dead: the packaging README's project site address https://solr.apache.org/solr (404); the personal page the contributor guide cites for not emailing committers (404, also on the successor host for Apache personal pages); the help directory, which no longer exists in the tree; the PMC chair guide's GitHub reference (redirects to a wiki page answering 404); the Git guide's crash course (403); and the shortlink in the RelatednessAgg javadoc (its target answers 400 on the current list archive).
Stale content: the changelog guide gives the fragment folder as
solr/changelog/unreleased/, but nosolr/changelogdirectory exists; fragments live inchangelog/unreleased/at the repository root. The JVM guide's test example points at a JDK 14 install; the build's minimum Java version is 21. The FAQ says Error Prone runs on Jenkins and describes Sonatype Lift as reviewing pull requests; PR checks run as GitHub Actions and no Lift configuration exists in this repository. Two pages point at the removedhelp/directory for the Gradle help texts (source code guide, dev-docs index); those texts live indev-docs/gradle-help/. The contributor guide also omits that a first-time contributor's workflow runs wait for a maintainer's approval.Every other external address in these docs was requested directly on 2026-10-22 and 2026-10-23, including a full sweep of dev-docs (42 files, 182 unique addresses). The seven above are the dead ones; the only other non-answers are behind ASF login walls (reporter.apache.org, whimsy, the private PMC area), which is by design.
What this change does
Each dead reference now points at a live address carrying the same content or its current canonical home, and the stale statements are corrected. Thirteen files change; the only code file touched is a javadoc comment.
The four Slack references now point at the project's #solr-dev channel in the ASF Slack workspace (CONTRIBUTING.md, README.md, README.txt, index.html), the channel address the project publishes on its community page and that README's Get Involved section already uses. The site address in the packaging README is now the site root, https://solr.apache.org/ (README.txt). The contributor guide cites the ASF email tips page instead of the dead personal page (how-to-contribute.adoc); it carries the same guidance: "Do not send development or use questions in private emails. Keep the discussion on the mailing list." The source code guide points at the dev-docs directory (solr-source-code.adoc). The PMC chair guide's see-also points at GitBox (pmc-chair.adoc). The Git guide's crash course bullet points at the Pro Git chapter for SVN users (git.adoc), and its beginners bullet, which pointed at a "let me google that for you" joke link, now points at the Git Tutorial on git-scm.com (git.adoc). The RelatednessAgg citation links the cited message in the MARC archive, which resolves its Message-ID (RelatednessAgg.java).
The content corrections:
changelog/unreleased/at the repository root, the layout drawing matches the folders that exist, and the task name is spelledwriteChangelogthroughout (changelog.adoc)../gradlew devlike the rest of the docs (FAQ.adoc).dev-docs/gradle-help; the source code guide'schecksentence is completed (solr-source-code.adoc, README.adoc).Proof
Every address named here was requested directly on 2026-10-22 and 2026-10-23.
helpdirectory exists in the tree. New: the dev-docs tree answers 200.gradle/changelog.gradledefineswriteChangelogwriting tochangelog/unreleased/;gradle/libs.versions.tomlsets the minimum Java version to 21; no.lift.tomlor other Lift configuration exists in the repository;.github/workflows/gradle-precommit.ymlrunscheck -x testas a GitHub Action on pull requests../gradlew :solr:core:tidyruns clean on the branch, and:solr:core:check -x testpasses at head8ae42dc5e89, verified 2026-10-23.A choice to check
Recommendation: point these pages at the ASF #solr-dev channel, as this PR does, rather than removing the Slack references.
The old address was a public sign-up for a community Slack workspace, and no public sign-up exists today: the invite service has shut down and its successor has no page for the workspace. The project's community page is not a fallback; it sends readers to the same dead address. What exists is the ASF workspace's #solr-dev channel, which ASF members enter directly and other contributors enter as invited guests, a route ASF Infra documents. The project's own dev docs send readers to that channel for detailed questions.
The deciding question: should these pages promise only destinations any reader can walk into unaided? If so, the Slack lines should come out of all four pages until a public sign-up exists again, leaving IRC as the open chat. If a pointer to the room the developers actually use is worth the guest step, the channel link is the destination. These pages exist to help readers reach the project and the developers are in that channel, so the PR keeps the pointer. Reviewers who weigh the guest step differently would land on removal.
Limits
Checklist
mainbranch../gradlew check. Not run in full: link and wording changes plus one javadoc comment;:solr:core:tidyruns clean and:solr:core:check -x testpasses at the head.AI-generated description. Nick Shanin directed the work and takes responsibility for this contribution.