[
https://issues.apache.org/jira/browse/STORM-3471?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16889750#comment-16889750
]
Stig Rohde Døssing commented on STORM-3471:
-------------------------------------------
Hi Rui. I don't believe this is an issue. The docs you are looking at are not
intended to be read from the Storm source repository. They're available on the
Storm site under the "Documentation" tab. The placeholder you are seeing is not
replaced until the Storm site is generated. The files you're looking at contain
placeholders, which get replaced by Jekyll when the site is built. Going to
https://storm.apache.org/releases/2.0.0/Metrics.html and clicking on
AssignableMetric correctly links to
https://github.com/apache/storm/blob/v2.0.0/storm-client/src/jvm/org/apache/storm/metric/api/AssignableMetric.java.
We just put up a bit of extra documentation linking to the storm-site
repository here
https://github.com/apache/storm/blob/master/DEVELOPER.md#contribute-documentation.
You can take a look at the README in this repository to get an idea how we
build the site https://github.com/apache/storm-site. Basically we copy the
/docs directory into storm-site under the "releases" directory, and run a
command to get Jekyll to make a site from our sources. It's at this point the
placeholders get replaced.
> {{page.git-blob-base}} variable is mis-interpreted across all documentation
> ---------------------------------------------------------------------------
>
> Key: STORM-3471
> URL: https://issues.apache.org/jira/browse/STORM-3471
> Project: Apache Storm
> Issue Type: Improvement
> Components: documentation
> Reporter: Rui Li
> Assignee: Rui Li
> Priority: Minor
> Labels: documentation
>
> *Edited. After having looked into source code, it looks like many hyperlinks
> are using parameter
> {\{page.git-blob-base}} which is rendered as
> [https://github.com/apache/storm/blob/master/docs/%7B%7Bpage.git-blob-base%7D%7D]
> instead of the correct path [https://github.com/apache/storm/blob/master/] .
> Looks like a configuration issue, but I am not sure where to make the proper
> fix.
> For example in
> [Metrics.md|https://github.com/apache/storm/blob/master/docs/Metrics.md]:
> Clicking into [AssignableMetric](
> {\{page.git-blob-base}}/storm-client/src/jvm/org/apache/storm/metric/api/AssignableMetric.java)
> will lead to a 404 page
> [https://github.com/apache/storm/blob/master/docs/%7B%7Bpage.git-blob-base%7D%7D/storm-client/src/jvm/org/apache/storm/metric/api/AssignableMetric.java].
> The correct location will be
> [https://github.com/apache/storm/blob/master/storm-client/src/jvm/org/apache/storm/metric/api/AssignableMetric.java]
--
This message was sent by Atlassian JIRA
(v7.6.14#76016)
