[
https://issues.apache.org/jira/browse/HBASE-22986?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16944637#comment-16944637
]
Toshihiro Suzuki edited comment on HBASE-22986 at 10/4/19 4:18 PM:
-------------------------------------------------------------------
Thanks. [~busbey]
I checked the script:
https://github.com/apache/hbase/blob/master/dev-support/jenkins-scripts/generate-hbase-website.sh
It looks like the images dir in the hbase-site repo is overwritten by the
images dir that are generated by *mvn site:stage* in the main repo. That's why
the images of hbtop were deleted.
And, I realized that most of the images in the ref guide are in
https://github.com/apache/hbase/tree/master/src/site/resources/images and just
the file name is specified as *image* element type in the doc (e.g.
image::WAL_splitting.png[]).
https://hbase.apache.org/book.html#_hbase_reference_guide_style_guide_and_cheat_sheet
If I want to put the images of hbtop to the doc in the same way, I need to put
the images to the images directory in the main repo. However, that doesn't
achieve the first goal (removing the images of hbtop from the main repo).
So, I think we can do the following:
1. Put the images of hbtop to another directory than the images directory in
hbase-site repo (like hbtop-images)
2. In the ref guide, we specify the images of hbtop as a remote image like the
following:
image::http://hbase.apache.org/hbtop-images/top_screen.gif
What do you think?
was (Author: brfrn169):
Thanks. [~busbey]
I checked the script:
https://github.com/apache/hbase/blob/master/dev-support/jenkins-scripts/generate-hbase-website.sh
It looks like the images dir in the hbase-site repo is overwritten by the
images dir that are generated by *mvn site:stage* in the main repo. That's why
the images of hbtop were deleted.
And, I realized that most of the images in the ref guide are in
https://github.com/apache/hbase/tree/master/src/site/resources/images and just
the file name is specified as *image* element type in the doc (e.g.
image::WAL_splitting.png[]).
https://hbase.apache.org/book.html#_hbase_reference_guide_style_guide_and_cheat_sheet
If I want to put the images of hbtop to the doc in the same way, I need to put
the images to the images directory in the main repo. However, that doesn't
achieve the first goal (removing the images of hbtop from the main repo).
So, I think we can do the following:
1. Put the images of hbtop to another directory than the images directory (like
hbtop-images) in hbase-site repo
2. In the ref guide, we specify the images of hbtop as a remote image like the
following:
image::http://hbase.apache.org/hbtop-images/top_screen.gif
What do you think?
> Add documentation for hbtop
> ---------------------------
>
> Key: HBASE-22986
> URL: https://issues.apache.org/jira/browse/HBASE-22986
> Project: HBase
> Issue Type: Sub-task
> Components: documentation, hbtop
> Reporter: Toshihiro Suzuki
> Assignee: Toshihiro Suzuki
> Priority: Minor
>
> We already have README for hbtop, so we can make the refguide refer to this:
> [https://github.com/apache/hbase/blob/master/hbase-hbtop/README.md]
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
