[jira] [Commented] (TINKERPOP-1362) nest steps in reference doc

[Jason Plurad (JIRA)]

[ 
https://issues.apache.org/jira/browse/TINKERPOP-1362?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15890913#comment-15890913
 ] 

Jason Plurad commented on TINKERPOP-1362:
-

I see what you're saying about the headers. I think the idea is good, but in 
practice it'll end up making the TOC too fine-grained. It is already very long 
as it is.

> nest steps in reference doc
> ---
>
> Key: TINKERPOP-1362
> URL: https://issues.apache.org/jira/browse/TINKERPOP-1362
> Project: TinkerPop
>  Issue Type: Improvement
>  Components: documentation
>Affects Versions: 3.2.0-incubating, 3.1.2-incubating
>Reporter: Jason Plurad
>Priority: Trivial
>  Labels: easyfix, newbie
>
> A colleague recommended that the reference doc should include links on the 
> left to some of the steps that are hidden underneath other steps. For example:
> * Lambda Steps
> ** Map
> ** FlatMap
> ** Filter
> ** SideEffect
> ** Branch
> * Has Step
> ** Has
> ** HasLabel
> ** HasId
> ** HasKey
> ** HasValue
> ** HasNot



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)

[jira] [Commented] (TINKERPOP-1362) nest steps in reference doc

[stephen mallette (JIRA)]

[ 
https://issues.apache.org/jira/browse/TINKERPOP-1362?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15876717#comment-15876717
 ] 

stephen mallette commented on TINKERPOP-1362:
-

I sorta like this idea, but not sure how we would do this with asciidoc. The 
menu on the left is controlled by headers in the asciidoc, so without adding 
all those steps as individual sections i don't see how this one can get done 
and I'm not sure we want to start going down that path as some of the grouped 
steps seem to make sense the way they are currently documented. wdyt [~pluradj] 
?

> nest steps in reference doc
> ---
>
> Key: TINKERPOP-1362
> URL: https://issues.apache.org/jira/browse/TINKERPOP-1362
> Project: TinkerPop
>  Issue Type: Improvement
>  Components: documentation
>Affects Versions: 3.2.0-incubating, 3.1.2-incubating
>Reporter: Jason Plurad
>Priority: Trivial
>  Labels: easyfix, newbie
>
> A colleague recommended that the reference doc should include links on the 
> left to some of the steps that are hidden underneath other steps. For example:
> * Lambda Steps
> ** Map
> ** FlatMap
> ** Filter
> ** SideEffect
> ** Branch
> * Has Step
> ** Has
> ** HasLabel
> ** HasId
> ** HasKey
> ** HasValue
> ** HasNot



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)