[
https://issues.apache.org/jira/browse/MATH-1604?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17696556#comment-17696556
]
Gilles Sadowski commented on MATH-1604:
---------------------------------------
Here is an example of the issues which this report is about:
# Visit [this page (about descriptive
statistics)|https://commons.apache.org/proper/commons-math/userguide/stat.html#a1.2_Descriptive_statistics]
of the userguide.
# Then click on e.g. [the first link on that
page|https://commons.apache.org/proper/commons-math/apidocs/org/apache/commons/math4/stat/descriptive/UnivariateStatistic.html].
As of today, it returns "Not found" because
# the package layout has changed in version 4.0
# the top-level directory of the (rendered) Javadoc is now elsewhere in the
repository
For the example above the correct link is
https://commons.apache.org/proper/commons-math/commons-math-docs/apidocs/org/apache/commons/math4/legacy/stat/descriptive/UnivariateStatistic.html
The userguide is rendered as part of the "site" build, by the following command:
{noformat}
$ mvn site site:stage
{noformat}
The input files (those that need to be updated) are in directory
[src/site/xdoc|https://gitbox.apache.org/repos/asf?p=commons-math.git;a=tree;f=src/site/xdoc;h=90b6b9af9c5e177bd8c94d0d5524e8fa1f34cd8c;hb=HEAD].
For the example above, file
["stat.xml"|https://gitbox.apache.org/repos/asf?p=commons-math.git;a=blob_plain;f=src/site/xdoc/userguide/stat.xml;hb=HEAD]
contains this line:
{noformat}
<a
href="../apidocs/org/apache/commons/math4/stat/descriptive/UnivariateStatistic.html">
UnivariateStatistic</a>
{noformat}
which should be changed to
{noformat}
<a
href="../apidocs/org/apache/commons/math4/legacy/stat/descriptive/UnivariateStatistic.html">
UnivariateStatistic</a>
{noformat}
So in summary: Source files of the userguide must be changed, then the HTML
pages must produced (by the command mentioned above), then the results must be
visually checked on your local machine (by visiting the rendered HTML generated
in the "target/staging" directory of the maven project).
> Userguide
> ---------
>
> Key: MATH-1604
> URL: https://issues.apache.org/jira/browse/MATH-1604
> Project: Commons Math
> Issue Type: Sub-task
> Reporter: Gilles Sadowski
> Priority: Major
> Fix For: 4.0
>
>
> Review
> [contents|https://gitbox.apache.org/repos/asf?p=commons-math.git;a=tree;f=src/site/xdoc/userguide;h=ac16fa8ddccf2d131958dbee64795e14bcc44b74;hb=HEAD]
> and
> * (x) update links, classes and packages according to the new package layout
> (cf. MATH-1575)
> * (/) replace sections about utilities moved elsewhere with a link to the
> web site of the respective components:
> ** (/) "Commons RNG" [https://commons.apache.org/rng]
> ** (/) "Commons Numbers" [https://commons.apache.org/numbers]
> ** (/) "Commons Geometry" [https://commons.apache.org/geometry]
> ** (/) "Commons Statistics" [https://commons.apache.org/statistics]
> * (/) check whether some of the documentation should be moved to another
> component (in which case an issue should be filed on the corresponding JIRA
> project):
> ** (/) "Commons RNG" https://issues.apache.org/jira/browse/RNG
> ** (/) "Commons Numbers" https://issues.apache.org/jira/browse/NUMBERS
> ** (/) "Commons Geometry" https://issues.apache.org/jira/browse/GEOMETRY
> ** (/) "Commons Statistics" https://issues.apache.org/jira/browse/STATISTICS
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
