dsmiley commented on code in PR #5180:
URL: https://github.com/apache/solr/pull/5180#discussion_r4309399515
##########
solr/solr-ref-guide/build.gradle:
##########
@@ -487,6 +487,8 @@ task checkSiteLinks(type: NpxTask) {
"--debug",
// Ignore the java docs url in the header, since it is an absolute path
"--url-ignore",
"${project(':solr:documentation').docroot.toPath()}/index\\.html",
+ // Changes.html is generated by release tooling, not by the local
documentation build.
+ "--url-ignore",
"${project(':solr:documentation').docroot.toPath()}/changes/Changes\\.html",
Review Comment:
if we're already ignoring `"--url-ignore", "file:/"`, would that cover this
and index.html too?
##########
dev-docs/solr-source-code.adoc:
##########
@@ -34,7 +34,7 @@ To build the documentation, type `./gradlew -p solr
documentation`.
`./gradlew check` will assemble Solr and run all validation tasks unit tests.
-NOTE: the `check` command requires `python3` to be present on your `PATH` to
validate documentation.
+NOTE: the `check` command does not need Python to validate documentation.
`Changes.html` is generated by the Python release tooling when preparing a
release.
Review Comment:
LOL same comment ;-). I'll be referring to this when telling people the
kind of thing AI coding tools screw up routinely.
##########
solr/distribution/build.gradle:
##########
Review Comment:
it's not clear to me why the gradle build must be aware of the HTML form of
the changelog
##########
dev-docs/how-to-contribute.adoc:
##########
@@ -33,7 +33,7 @@ In order to make a new contribution to Solr you will use the
fork you have creat
1. Create a new Jira issue in the Solr project:
https://issues.apache.org/jira/projects/SOLR/issues
2. Create a new branch in your Solr fork to provide a PR for your contribution
on the newly created issue. Make any necessary changes for the given
bug/feature in that branch. You can use additional information in these
dev-docs to build and test your code as well as ensure it passes code quality
checks.
3. Once you are satisfied with your changes, get your branch ready for a PR by
running `./gradlew tidy updateLicenses check -x test`. This will format your
source code, update licenses of any dependency version changes and run all
pre-commit tests. Commit the changes.
-* Note: the `check` command requires `python3` to be present on your `PATH` to
validate documentation.
+* Note: the `check` command does not need Python to validate documentation.
`Changes.html` is generated by the Python release tooling when preparing a
release.
Review Comment:
LOL while we're at it, we could list a host of technologies that are *not*
needed ;-)
I'll be more direct: drop the note entirely.
##########
dev-tools/scripts/test_changes2html.py:
##########
Review Comment:
does anything invoke this test? Meaning; does it run routinely, e.g. via
CI? I'm skeptical.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
