Skip to content

Commit 41a42af

Browse files
committed
Update doc links to use Antora pages
1 parent 9576f0d commit 41a42af

File tree

21 files changed

+31
-31
lines changed

21 files changed

+31
-31
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@ I hereby agree to the terms of the [JUnit Contributor License Agreement](https:/
1313
- [ ] [Coding conventions](https://github.com/junit-team/junit-framework/blob/HEAD/CONTRIBUTING.md#coding-conventions) (e.g. for logging) have been followed
1414
- [ ] Change is covered by [automated tests](https://github.com/junit-team/junit-framework/blob/HEAD/CONTRIBUTING.md#tests) including corner cases, errors, and exception handling
1515
- [ ] Public API has [Javadoc](https://github.com/junit-team/junit-framework/blob/HEAD/CONTRIBUTING.md#javadoc) and [`@API` annotations](https://apiguardian-team.github.io/apiguardian/docs/current/api/org/apiguardian/api/API.html)
16-
- [ ] Change is documented in the [User Guide](https://docs.junit.org/snapshot/user-guide/) and [Release Notes](https://docs.junit.org/snapshot/user-guide/#release-notes)
16+
- [ ] Change is documented in the [User Guide](https://docs.junit.org/snapshot/) and [Release Notes](https://docs.junit.org/snapshot/release-notes.html)

.github/scripts/create-github-release.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ module.exports = async ({ github, context }) => {
66
tag_name: `r${releaseVersion}`,
77
name: `JUnit ${releaseVersion}`,
88
generate_release_notes: true,
9-
body: `JUnit ${releaseVersion} = Platform ${releaseVersion} + Jupiter ${releaseVersion} + Vintage ${releaseVersion}\n\nSee [Release Notes](https://docs.junit.org/${releaseVersion}/release-notes/).`,
9+
body: `JUnit ${releaseVersion} = Platform ${releaseVersion} + Jupiter ${releaseVersion} + Vintage ${releaseVersion}\n\nSee [Release Notes](https://docs.junit.org/${releaseVersion}/release-notes.html).`,
1010
prerelease: releaseVersion.includes("-"),
1111
};
1212
console.log(requestBody);

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ is as follows:
161161

162162
The JUnit project uses the `@API` annotation from [API Guardian](https://github.com/apiguardian-team/apiguardian).
163163
Publicly available interfaces, classes, and methods have a defined lifecycle
164-
which is described in detail in the [User Guide](https://docs.junit.org/current/user-guide/#api-evolution).
164+
which is described in detail in the [User Guide](https://docs.junit.org/current/api-evolution.html).
165165

166166
That following describes the deprecation process followed for API items.
167167

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -100,14 +100,14 @@ of the JUnit Platform, JUnit Jupiter, and JUnit Vintage.
100100

101101
[Codecov]: https://codecov.io/gh/junit-team/junit-framework
102102
[CONTRIBUTING.md]: https://github.com/junit-team/junit-framework/blob/HEAD/CONTRIBUTING.md
103-
[Dependency Metadata]: https://docs.junit.org/current/user-guide/#dependency-metadata
103+
[Dependency Metadata]: https://docs.junit.org/current/appendix.html#dependency-metadata
104104
[GitHub Discussions]: https://github.com/junit-team/junit-framework/discussions/categories/q-a
105105
[Gradle toolchains]: https://docs.gradle.org/current/userguide/toolchains.html
106106
[Gradle Wrapper]: https://docs.gradle.org/current/userguide/gradle_wrapper.html#sec:using_wrapper
107107
[JaCoCo]: https://www.eclemma.org/jacoco/
108-
[Javadoc]: https://docs.junit.org/current/api/
108+
[Javadoc]: https://api.junit.org
109109
[JDK 25]: https://javaalmanac.io/jdk/25/
110-
[Release Notes]: https://docs.junit.org/current/release-notes/
110+
[Release Notes]: https://docs.junit.org/current/release-notes.html
111111
[Examples]: https://github.com/junit-team/junit-examples
112112
[StackOverflow]: https://stackoverflow.com/questions/tagged/junit5
113-
[User Guide]: https://docs.junit.org/current/user-guide/
113+
[User Guide]: https://docs.junit.org

documentation/modules/ROOT/partials/release-notes/release-notes-6.0.0.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,4 @@
2020
* Removal of various deprecated behaviors and APIs
2121

2222
For complete details consult the
23-
https://docs.junit.org/6.0.0/release-notes/[6.0.0 Release Notes] online.
23+
https://docs.junit.org/6.0.0/release-notes.html[6.0.0 Release Notes] online.

documentation/src/javadoc/junit-overview.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,6 @@
2424
</dd>
2525
</dl>
2626

27-
<p>Already consulted the <a href="../user-guide/index.html">JUnit User Guide</a>?</p>
27+
<p>Already consulted the <a href="../overview.html">JUnit User Guide</a>?</p>
2828

2929
</body>

junit-bom/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ or [Gradle]. Please refer to the [User Guide] for details.
55

66
[Maven]: https://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html#Importing_Dependencies
77
[Gradle]: https://docs.gradle.org/current/userguide/platforms.html#sub:bom_import
8-
[User Guide]: https://docs.junit.org/current/user-guide/#dependency-metadata-junit-bom
8+
[User Guide]: https://docs.junit.org/current/appendix.html#dependency-metadata-junit-bom

junit-jupiter-api/src/main/java/org/junit/jupiter/api/util/DefaultLocale.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,14 +59,14 @@
5959
* configurations will override the class level default {@code Locale}.
6060
*
6161
* <p>During
62-
* <a href="https://docs.junit.org/current/user-guide/#writing-tests-parallel-execution">parallel test execution</a>,
62+
* <a href="https://docs.junit.org/current/writing-tests/parallel-execution.html">parallel test execution</a>,
6363
* all tests annotated with {@link DefaultLocale @DefaultLocale},
6464
* {@link ReadsDefaultLocale @ReadsDefaultLocale}, and
6565
* {@link WritesDefaultLocale} are scheduled in a way that guarantees
6666
* correctness under mutation of shared global state.
6767
*
6868
* <p>For more details and examples, see the
69-
* <a href="https://docs.junit.org/current/user-guide/#writing-tests-built-in-extensions-DefaultLocale">User Guide</a>.
69+
* <a href="https://docs.junit.org/current/writing-tests/built-in-extensions.html#DefaultLocale">User Guide</a>.
7070
*
7171
* @since 6.1
7272
* @see Locale#getDefault()

junit-jupiter-api/src/main/java/org/junit/jupiter/api/util/DefaultTimeZone.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,14 +40,14 @@
4040
* default {@code TimeZone}.
4141
*
4242
* <p>During
43-
* <a href="https://docs.junit.org/current/user-guide/#writing-tests-parallel-execution">parallel test execution</a>,
43+
* <a href="https://docs.junit.org/current/writing-tests/parallel-execution.html">parallel test execution</a>,
4444
* all tests annotated with {@link DefaultTimeZone @DefaultTimeZone},
4545
* {@link ReadsDefaultTimeZone @ReadsDefaultTimeZone}, and
4646
* {@link WritesDefaultTimeZone @WritesDefaultTimeZone} are scheduled in a way that
4747
* guarantees correctness under mutation of shared global state.
4848
*
4949
* <p>For more details and examples, see the
50-
* <a href="https://docs.junit.org/current/user-guide/#writing-tests-built-in-extensions-DefaultTimeZone">User Guide</a>.
50+
* <a href="https://docs.junit.org/current/writing-tests/built-in-extensions.html#DefaultTimeZone">User Guide</a>.
5151
*
5252
* @since 6.1
5353
* @see TimeZone#getDefault()

junit-jupiter-api/src/main/java/org/junit/jupiter/api/util/ReadsDefaultLocale.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,14 @@
2828
* {@link DefaultLocale @DefaultLocale} extension themselves.
2929
*
3030
* <p>During
31-
* <a href="https://docs.junit.org/current/user-guide/#writing-tests-parallel-execution">parallel test execution</a>,
31+
* <a href="https://docs.junit.org/current/writing-tests/parallel-execution.html">parallel test execution</a>,
3232
* all tests annotated with {@link DefaultLocale @DefaultLocale},
3333
* {@link ReadsDefaultLocale @ReadsDefaultLocale}, and
3434
* {@link WritesDefaultLocale} are scheduled in a way that guarantees
3535
* correctness under mutation of shared global state.
3636
*
3737
* <p>For more details and examples, see the
38-
* <a href="https://docs.junit.org/current/user-guide/#writing-tests-built-in-extensions-DefaultLocale">User Guide</a>.
38+
* <a href="https://docs.junit.org/current/writing-tests/built-in-extensions.html#DefaultLocale">User Guide</a>.
3939
*
4040
* @since 6.1
4141
* @see DefaultLocale

0 commit comments

Comments
 (0)