[
https://issues.apache.org/jira/browse/HTRACE-350?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15225203#comment-15225203
]
Colin Patrick McCabe commented on HTRACE-350:
---------------------------------------------
Thanks for the review, [~iwasakims].
bq. The link to index.html should be removed from site.xml. We should have a
link to developer_guide.html instead.
fixed
bq. Links in the developer_guilde.md are relative paths to source files. It
might work in github source browser but not in compiled site documentation. Is
it possible to stage source files along with htmls to web server?
Good point. I replaced them with links to the latest release on Github. Like
this:
https://github.com/apache/incubator-htrace/blob/rel/4.1/htrace-c/src/core/htrace.h
I think staging the source code files to the web server is a good idea, but we
should do that in a follow-on so we can get this in. It will be nice to have
people able to see the new developer docs!
> Add a developer guide
> ---------------------
>
> Key: HTRACE-350
> URL: https://issues.apache.org/jira/browse/HTRACE-350
> Project: HTrace
> Issue Type: Improvement
> Components: docs
> Affects Versions: 4.2
> Reporter: Colin Patrick McCabe
> Assignee: Colin Patrick McCabe
> Attachments: HTRACE-350.001.patch, HTRACE-350.002.patch
>
>
> We should add a developer guide to make it easier for people to integrate
> HTrace into their applications.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
