This is an automated email from the ASF dual-hosted git repository. dsmiley pushed a commit to branch branch_10x in repository https://gitbox.apache.org/repos/asf/solr.git
commit c53b48b097e78f17f40188a6c174d8a1a67cb89d Author: Nick <[email protected]> AuthorDate: Thu Oct 29 16:42:46 2026 -0600 SOLR-18577: Fix dead links and stale workflow content in the contributor docs (#5212) Backport delta: dev-docs/changelog.adoc section 3.1 keeps branch_10x's text; the writeChangelogPr paragraph is omitted since that Gradle task (#4536) is not on this branch. (cherry picked from commit 9859d8bb2e8d63061116b8281639a4beb1be480c) --- CONTRIBUTING.md | 2 +- README.md | 2 +- changelog/unreleased/contributing-slack-link.yml | 7 +++++++ dev-docs/FAQ.adoc | 11 +++-------- dev-docs/README.adoc | 2 +- dev-docs/changelog.adoc | 14 ++++++-------- dev-docs/git.adoc | 4 ++-- dev-docs/how-to-contribute.adoc | 4 ++-- dev-docs/jvms.adoc | 2 +- dev-docs/pmc-chair.adoc | 2 +- dev-docs/solr-source-code.adoc | 6 +++--- .../java/org/apache/solr/search/facet/RelatednessAgg.java | 5 +++-- solr/packaging/README.txt | 4 ++-- solr/webapp/web/index.html | 2 +- 14 files changed, 34 insertions(+), 33 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b1ca94f5ce7..74fd5aa13cd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -21,7 +21,7 @@ Thank you for your interest in contributing to the Apache Solr project. Solr con Your suggestions and comments can be made directly through the [Apache Solr JIRA](https://issues.apache.org/jira/projects/SOLR/issues). -There are many ways to participate in and contribute to Solr, such as: code implementation, test implementation, documentation improvements. Participating in the user mailing list, being active on [Solr Slack](https://s.apache.org/solr-slack) answering questions and providing feedback to developers are also powerful ways to contribute to Solr. +There are many ways to participate in and contribute to Solr, such as: code implementation, test implementation, documentation improvements. Participating in the user mailing list, being active on [Solr Slack](https://the-asf.slack.com/messages/CE70MDPMF) answering questions and providing feedback to developers are also powerful ways to contribute to Solr. The community is also always looking for [moderators](#be-a-mailing-list-moderator) for the mailing lists. If you have any questions along the way, you can reach out to the community using the resources provided [here](https://solr.apache.org/community.html#mailing-lists-chat). diff --git a/README.md b/README.md index 24d419bd472..61171adc7b2 100644 --- a/README.md +++ b/README.md @@ -73,7 +73,7 @@ Guide](https://solr.apache.org/guide/solr/latest/getting-started/solr-tutorial.h ## Support - [Users Mailing List](https://solr.apache.org/community.html#mailing-lists-chat) -- Slack: Solr Community Channel. Sign up at https://s.apache.org/solr-slack +- Slack: [#solr-dev channel in the ASF Slack workspace](https://the-asf.slack.com/messages/CE70MDPMF) - IRC: `#solr` on [libera.chat](https://web.libera.chat/?channels=#solr) ## Developer Documentation diff --git a/changelog/unreleased/contributing-slack-link.yml b/changelog/unreleased/contributing-slack-link.yml new file mode 100644 index 00000000000..3dbb3d1b7a0 --- /dev/null +++ b/changelog/unreleased/contributing-slack-link.yml @@ -0,0 +1,7 @@ +title: Update Solr support and contributor links +type: other +authors: + - name: Nick Shanin +links: + - name: PR#5212 + url: https://github.com/apache/solr/pull/5212 diff --git a/dev-docs/FAQ.adoc b/dev-docs/FAQ.adoc index 6baa9d491d1..ba51dbd0394 100644 --- a/dev-docs/FAQ.adoc +++ b/dev-docs/FAQ.adoc @@ -25,9 +25,9 @@ You can review instructions for running Solr in Docker in the xref:running-in-do === What's the fastest build lifecycle for frontend work on Solr Admin? -Run `gradle dev`, and then `cd ./packaging/build/dev/`. Fire up your cluster +Run `./gradlew dev`, and then `cd ./packaging/build/dev/`. Fire up your cluster via `bin/solr start -e cloud --no-prompt` and then as you make changes to assets in `/solr/webapp/web`, -run `gradle dev` to redeploy the web assets. Do a hard refresh in your browser +run `./gradlew dev` to redeploy the web assets. Do a hard refresh in your browser to pick up your changes. === Are there Coding Standards to follow? @@ -53,15 +53,10 @@ If you find a bug, write a test demonstrating it, so we can ensure that once the The Eclipse IDE's linting tool ECJ is applied as part of the `check` task. https://errorprone.info/[Error Prone] goes beyond static type checking and recommends fixes for common bug patterns. -Error Prone is run during the CI build on Jenkins, however to run it locally (and skip the tests) do: +Error Prone is run during the CI build, however to run it locally (and skip the tests) do: `./gradlew check -Pvalidation.errorprone=true -x test` -In the same space as Errorprone is https://lift.sonatype.com/[Sonatype Lift], an automated code reviewer that is run when you push your PR to Github. -As with human reviewers, it's a good practice to respond to each comment to reflect on the recommendation. -Of course, automated code analysis will turn up false-positives. -Tip: There is no point in responding to Lift with the ignore command because we don't gate PRs on Lift. - There are Java classes and methods that Solr doesn't allow. This exclusion is enforced by the https://github.com/policeman-tools/forbidden-apis[Forbidden APIs] tool and is applied as part of the `check` task. Learn more about using Forbidden APIs via `./gradlew :helpForbiddenApis`. diff --git a/dev-docs/README.adoc b/dev-docs/README.adoc index 49570d7a0a9..cff69f1a4ac 100644 --- a/dev-docs/README.adoc +++ b/dev-docs/README.adoc @@ -3,7 +3,7 @@ This directory includes information for Solr developers. There are some other sources of information for learning about developing on Solr: -1. The help .txt files for the Gradle commands in the `help/` directory. +1. The help .txt files for the Gradle commands in the `gradle-help/` subdirectory. 2. Information on how to handle adding dependencies and related licensing details, see the information in `/solr/licenses/README.committers.txt`. diff --git a/dev-docs/changelog.adoc b/dev-docs/changelog.adoc index aa65c924e97..566d12d8337 100644 --- a/dev-docs/changelog.adoc +++ b/dev-docs/changelog.adoc @@ -5,7 +5,7 @@ The project no longer maintains a monolithic *CHANGES.txt* file directly. Instead, we create small YAML fragments **per bug-fix or feature**, checked into -the `solr/changelog/unreleased/ folder`. At release time these fragments are +the `changelog/unreleased/` folder at the root of the repository. At release time these fragments are organized in versioned folders and collated into a human-readable *CHANGELOG.md* file. This document walks you through the workflow, explains the Gradle helpers @@ -26,13 +26,11 @@ the changelog. [source] ---- -solr/ -└── changelog/ - ├── unreleased/ ← new fragments live here - | └── SOLR-12345-fix-memory-leak.yml - ├── v9.8.0/ ← changes in already released versions - ├── v9.8.0/ - └── v9.9.0/ +changelog/ +├── unreleased/ ← new fragments live here +| └── SOLR-12345-fix-memory-leak.yml +├── v9.11.0/ ← changes in already released versions +└── v10.0.0/ ---- == 3. The YAML format diff --git a/dev-docs/git.adoc b/dev-docs/git.adoc index fe28ec0b0d4..97d595ae498 100644 --- a/dev-docs/git.adoc +++ b/dev-docs/git.adoc @@ -21,8 +21,8 @@ There are about a zillion "how to use Git" links out there, here are a few links * https://git-wip-us.apache.org/[Git at Apache] General Apache guidelines. * https://github.com/dweiss/lucene-git-guides[Dawid's guide] From our very own Dawid Weiss. -* http://git.or.cz/course/svn.html[Git for SVN crash course] For people who know SVN but not Git. -* http://lmgtfy.com/?q=Git+beginners+guide[Let Me Google That For You] I've wanted to paste a link to LMGTFY for a long time... +* https://git-scm.com/book/en/v2/Git-and-Other-Systems-Git-as-a-Client[Git as a Client (Pro Git)] For people who know SVN but not Git. +* https://git-scm.com/docs/gittutorial[Git Tutorial] For absolute beginners. The goal here is to provide a super-simple guide without getting off into the all the possibilities, and it will certainly seem "too simple" to sophisticated users. We all have to start somewhere. diff --git a/dev-docs/how-to-contribute.adoc b/dev-docs/how-to-contribute.adoc index 8e6772dcb76..c6614983a26 100644 --- a/dev-docs/how-to-contribute.adoc +++ b/dev-docs/how-to-contribute.adoc @@ -18,7 +18,7 @@ To see a list of open issues with the **newdev** label, look at this link https: Note: Fixing these issues may require asking questions on the developer list to figure out what they mean - there is no guarantee that any of these will be either quick or easy. -Emailing individual committers with questions about specific Solr issues is discouraged. See http://people.apache.org/~hossman/#private_q. +Emailing individual committers with questions about specific Solr issues is discouraged. See https://www.apache.org/dev/contrib-email-tips.html. ## Setup for Contributing In order to get setup you will need a fork of the Apache Solr repository and an account in the ASF Jira (usable for all Apache projects). @@ -36,7 +36,7 @@ In order to make a new contribution to Solr you will use the fork you have creat 4. Open a PR of your branch against the `main` branch of the apache/solr repository. When you open a PR on your fork, this should be the default option. * The title of your PR should include the Solr Jira issue that you opened, i.e. `SOLR-12345: New feature`. * The PR description will automatically populate with a pre-set template that you will need to fill out. -* The PR will run a gradle pre-commit task that will do some basic checks of your changes. This is run as a Github Action and the results can be viewed from your PR. +* The PR will run a gradle pre-commit task that will do some basic checks of your changes. This is run as a Github Action and the results can be viewed from your PR. If this is your first contribution, a maintainer has to approve the workflow runs before they start, so a wait before the first results is normal. * If you properly named your PR you will see it automatically linked to your Jira issue when you view the issue. * If your PR is still a work in progress, you can use the https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests#draft-pull-requests[PR Draft feature] of Github to denote draft status. 5. At this point, you will need a Solr committer to review your change and help to get it merged upstream. You can use the https://solr.apache.org/community.html[Solr Developers Mailing List] to get attention to your issue. diff --git a/dev-docs/jvms.adoc b/dev-docs/jvms.adoc index d5d485daed0..3f2f0b2f966 100644 --- a/dev-docs/jvms.adoc +++ b/dev-docs/jvms.adoc @@ -8,7 +8,7 @@ If property is being used, it can be a system property (-D...) or a project prop *Example:* -`gradlew test -p solr/test-framework --tests TestLogLevelAnnotations -Dtests.verbose=true -Druntime.java.home=/jvms/jdk14` +`gradlew test -p solr/test-framework --tests TestLogLevelAnnotations -Dtests.verbose=true -Druntime.java.home=/jvms/jdk25` Note that an alternative JVM can also be made the "default" setting by adding it to (project-local) gradle.properties. \ No newline at end of file diff --git a/dev-docs/pmc-chair.adoc b/dev-docs/pmc-chair.adoc index 24cb1db8045..ecb23216145 100644 --- a/dev-docs/pmc-chair.adoc +++ b/dev-docs/pmc-chair.adoc @@ -44,7 +44,7 @@ For a new committer to have permissions to make commits via GitHub and to also c After adding their GitHub ID, it can take 3-4 hours for the permissions in GitHub to be updated. The committer will need to make sure they have two-factor authentication (2FA) enabled in GitHub in order for the permissions to be granted. -See also https://reference.apache.org/committer/github. +See also https://gitbox.apache.org/. == Grant Karma to new PMC Members diff --git a/dev-docs/solr-source-code.adoc b/dev-docs/solr-source-code.adoc index 3301dbc7503..2ddc9a9d477 100644 --- a/dev-docs/solr-source-code.adoc +++ b/dev-docs/solr-source-code.adoc @@ -22,7 +22,7 @@ Use either `./gradlew devSlim` or `./gradlew devFull` to create just one type of NOTE: `gradlew` is the "Gradle Wrapper" and will automatically download and start using the correct version of Gradle for Solr. -NOTE: `./gradlew help` will print a list of high-level tasks. There are also a number of plain-text files in <source folder root>/help that you can browse. +NOTE: `./gradlew help` will print a list of high-level tasks. There are also a number of plain-text files in the `dev-docs/gradle-help` folder that you can browse. The first time you run Gradle, it will create a file "gradle.properties" that contains machine-specific settings. Normally you can use this file as-is, but it can be modified if necessary. @@ -32,7 +32,7 @@ The packaging directory is rewritten on each build. To build the documentation, type `./gradlew -p solr documentation`. -`./gradlew check` will assemble Solr and run all validation tasks unit tests. +`./gradlew check` will assemble Solr and run all validation tasks and unit tests. To build the final Solr artifacts run `./gradlew assemble`. @@ -77,4 +77,4 @@ If you do find one of these, here's what you should do: ## Additional Information You can review the https://github.com/apache/solr/blob/main/CONTRIBUTING.md[contribution guide] for information on how to contribute. -There are also additional helpful docs https://github.com/apache/solr/blob/main/help[in the help directory]. +There are also additional helpful docs https://github.com/apache/solr/tree/main/dev-docs[in the dev-docs directory]. diff --git a/solr/core/src/java/org/apache/solr/search/facet/RelatednessAgg.java b/solr/core/src/java/org/apache/solr/search/facet/RelatednessAgg.java index d35f5f46dec..dcc176d0a58 100644 --- a/solr/core/src/java/org/apache/solr/search/facet/RelatednessAgg.java +++ b/solr/core/src/java/org/apache/solr/search/facet/RelatednessAgg.java @@ -747,8 +747,9 @@ public class RelatednessAgg extends AggValueSource { * <p>See Also: * * <ul> - * <li><a href="https://s.apache.org/Mfu2";>java-user@lucene Message-ID: - * [email protected]</a> + * <li><a + * href="https://lists.apache.org/thread.html/3cwgfyncjl3m03fz5g9gblfmk3xjp20b";>java-user@lucene + * Message-ID: [email protected]</a> * <li><a * href="https://lingpipe-blog.com/2006/03/29/interesting-phrase-extraction-binomial-hypothesis-testing-vs-coding-loss/";>Phrase * Extraction: Binomial Hypothesis Testing vs. Coding Loss</a> diff --git a/solr/packaging/README.txt b/solr/packaging/README.txt index 7801ae00f49..b598a1ea48d 100644 --- a/solr/packaging/README.txt +++ b/solr/packaging/README.txt @@ -22,7 +22,7 @@ many of the world's largest organizations. For a complete description of the Solr project, team composition, source code repositories, and other details, please see the Solr web site at -https://solr.apache.org/solr +https://solr.apache.org/ How to Use ---------- @@ -47,7 +47,7 @@ Support ------- - Users Mailing List: https://solr.apache.org/community.html#mailing-lists-chat -- Slack: Solr Community Channel. Sign up at https://s.apache.org/solr-slack +- Slack: #solr-dev channel in the ASF Slack workspace: https://the-asf.slack.com/messages/CE70MDPMF - IRC: #solr on libera.chat: https://web.libera.chat/?channels=#solr diff --git a/solr/webapp/web/index.html b/solr/webapp/web/index.html index 6f63331ada2..85abdcebe32 100644 --- a/solr/webapp/web/index.html +++ b/solr/webapp/web/index.html @@ -270,7 +270,7 @@ limitations under the License. <li class="query-syntax"><a href="https://solr.apache.org/guide/solr/latest/query-guide/query-syntax-and-parsers.html"; target="_blank"><span>Solr Query Syntax</span></a></li> <li class="community"><a href="https://solr.apache.org/community.html"; target="_blank"><span>Community</span></a></li> <li class="issues"><a href="https://issues.apache.org/jira/browse/SOLR"; target="_blank"><span>Issue Tracker</span></a></li> - <li class="chat"><a href="https://s.apache.org/solr-slack"; target="_blank"><span>Slack</span></a></li> + <li class="chat"><a href="https://the-asf.slack.com/messages/CE70MDPMF"; target="_blank"><span>Slack</span></a></li> <li class="chat"><a href="https://web.libera.chat/?channels=#solr"; target="_blank"><span>IRC</span></a></li> </ul>
