[jira] [Commented] (PIO-129) CLI document does not expand side menu

[ASF GitHub Bot (JIRA)]

[ 
https://issues.apache.org/jira/browse/PIO-129?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16194149#comment-16194149
 ] 

ASF GitHub Bot commented on PIO-129:


Github user dszeto commented on the issue:

https://github.com/apache/incubator-predictionio/pull/438
  
LGTM. Merging. Thanks @takezoe !


> CLI document does not expand side menu
> --
>
> Key: PIO-129
> URL: https://issues.apache.org/jira/browse/PIO-129
> Project: PredictionIO
>  Issue Type: Improvement
>  Components: Documentation
>Reporter: Naoki Takezoe
>Assignee: Naoki Takezoe
>Priority: Minor
>
> There are links to CLI document in the deploy section and collecting data 
> section of the side menu, but if these links are clicked, the side menu is 
> closed because these links have a hash like {{/cli/#engine-commands}}. I 
> think that such unclear navigation would confuse readers.
> https://predictionio.incubator.apache.org/cli/#engine-commands
> I propose to remove these links from the deploy section and the collecting 
> data section, and put a link to CLI document in the resource section without 
> hash. In addition, put links to the CLI reference in documents of the event 
> server and the engine server.



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)

[jira] [Commented] (PIO-129) CLI document does not expand side menu

[ASF GitHub Bot (JIRA)]

[ 
https://issues.apache.org/jira/browse/PIO-129?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16192628#comment-16192628
 ] 

ASF GitHub Bot commented on PIO-129:


GitHub user takezoe opened a pull request:

https://github.com/apache/incubator-predictionio/pull/438

[PIO-129] Move CLI document

There are links to CLI document in the deploy section and collecting data 
section of the side menu, but if these links are clicked, the side menu is 
closed because these links have a hash like `/cli/#engine-commands`. I think 
that such unclear navigation would confuse readers.
https://predictionio.incubator.apache.org/cli/#engine-commands

I propose to remove these links from the deploy section and the collecting 
data section, and put a link to CLI document in the resource section without 
hash:


![cli-doc1](https://user-images.githubusercontent.com/1094760/31218456-5e1e312e-a9f5-11e7-8d8f-e4d1e06e3d08.png)

In addition, put links to the CLI reference in documents of the event 
server and the engine server. A following screenshot shows a link to the event 
server CLI in the document about deployment:


![cli-doc2](https://user-images.githubusercontent.com/1094760/31218708-248da2c2-a9f6-11e7-8a8a-6bef8ee1e6e5.png)




You can merge this pull request into a Git repository by running:

$ git pull https://github.com/takezoe/incubator-predictionio 
move-cli-document

Alternatively you can review and apply these changes as the patch at:

https://github.com/apache/incubator-predictionio/pull/438.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

This closes #438


commit f2446820a9b7dfbecd4e80a5cf4aaefb84518018
Author: Naoki Takezoe 
Date:   2017-10-05T08:25:34Z

Move CLI document




> CLI document does not expand side menu
> --
>
> Key: PIO-129
> URL: https://issues.apache.org/jira/browse/PIO-129
> Project: PredictionIO
>  Issue Type: Improvement
>  Components: Documentation
>Reporter: Naoki Takezoe
>Assignee: Naoki Takezoe
>Priority: Minor
>
> There are links to CLI document in the deploy section and collecting data 
> section of the side menu, but if these links are clicked, the side menu is 
> closed because these links have a hash like {{/cli/#engine-commands}}. I 
> think that such unclear navigation would confuse readers.
> https://predictionio.incubator.apache.org/cli/#engine-commands
> I propose to remove these links from the deploy section and the collecting 
> data section, and put a link to CLI document in the resource section without 
> hash. In addition, put links to the CLI reference in documents of the event 
> server and the engine server.



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)