[jira] [Comment Edited] (SPARK-19767) API Doc pages for Streaming with Kafka 0.10 not current

2017-03-01 Thread Nick Afshartous (JIRA)

[ 
https://issues.apache.org/jira/browse/SPARK-19767?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15888572#comment-15888572
 ] 

Nick Afshartous edited comment on SPARK-19767 at 3/1/17 10:15 PM:
--

Yes the code examples on the Integration Page are current.  The issue with the 
linked API pages looks like more than incompleteness because the package name 
{code}org.apache.spark.streaming.kafka{code} should be 
{code}org.apache.spark.streaming.kafka10{code}.  

I'd be happy to help.  Tried to build the doc running "jekyll build" from the 
docs dir and got the error below.  Is this target broken or my env ?  
{code}
[info] Note: Custom tags that could override future standard tags:  @todo, 
@note, @tparam, @constructor, @groupname, @example, @group. To avoid potential 
overrides, use at least one period character (.) in custom tag names.
[info] Note: Custom tags that were not seen:  @todo, @tparam, @constructor, 
@groupname, @group
[info] 1 error
[info] 100 warnings
[error] (spark/javaunidoc:doc) javadoc returned nonzero exit code
[error] Total time: 198 s, completed Feb 28, 2017 11:56:20 AM
jekyll 3.4.0 | Error:  Unidoc generation failed
{code}


was (Author: nafshartous):
Yes the code examples on the Integration Page are current.  The issue with the 
linked API pages looks like more than incompleteness because the package names
name {code}org.apache.spark.streaming.kafka{code} should be 
{code}org.apache.spark.streaming.kafka10{code}.  

I'd be happy to help.  Tried to build the doc running "jekyll build" from the 
docs dir and got the error below.  Is this target broken or my env ?  
{code}
[info] Note: Custom tags that could override future standard tags:  @todo, 
@note, @tparam, @constructor, @groupname, @example, @group. To avoid potential 
overrides, use at least one period character (.) in custom tag names.
[info] Note: Custom tags that were not seen:  @todo, @tparam, @constructor, 
@groupname, @group
[info] 1 error
[info] 100 warnings
[error] (spark/javaunidoc:doc) javadoc returned nonzero exit code
[error] Total time: 198 s, completed Feb 28, 2017 11:56:20 AM
jekyll 3.4.0 | Error:  Unidoc generation failed
{code}

> API Doc pages for Streaming with Kafka 0.10 not current
> ---
>
> Key: SPARK-19767
> URL: https://issues.apache.org/jira/browse/SPARK-19767
> Project: Spark
>  Issue Type: Bug
>  Components: Structured Streaming
>Affects Versions: 2.1.0
>Reporter: Nick Afshartous
>Priority: Minor
>
> The API docs linked from the Spark Kafka 0.10 Integration page are not 
> current.  For instance, on the page
>https://spark.apache.org/docs/latest/streaming-kafka-0-10-integration.html
> the code examples show the new API (i.e. class ConsumerStrategies).  However, 
> following the links
> API Docs --> (Scala | Java)
> lead to API pages that do not have class ConsumerStrategies) .  The API doc 
> package names  also have {code}streaming.kafka{code} as opposed to 
> {code}streaming.kafka10{code} 
> as in the code examples on streaming-kafka-0-10-integration.html.  



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

-
To unsubscribe, e-mail: issues-unsubscr...@spark.apache.org
For additional commands, e-mail: issues-h...@spark.apache.org



[jira] [Comment Edited] (SPARK-19767) API Doc pages for Streaming with Kafka 0.10 not current

2017-02-28 Thread Nick (JIRA)

[ 
https://issues.apache.org/jira/browse/SPARK-19767?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15888932#comment-15888932
 ] 

Nick edited comment on SPARK-19767 at 2/28/17 9:58 PM:
---

{{SKIP_API=1 jekyll build}}  yields the error

{code}
  Dependency Error: Yikes! It looks like you don't have 
/home/nafshartous/Projects/spark/docs/_plugins/include_example.rb or one of its 
dependencies installed. In order to use Jekyll as currently configured, you'll 
need to install this gem. The full error message from Ruby is: 'cannot load 
such file -- pygments' If you run into trouble, you can find helpful resources 
at https://jekyllrb.com/help/! 
jekyll 3.4.0 | Error:  
/home/nafshartous/Projects/spark/docs/_plugins/include_example.rb
{code}

The file {{_plugins/include_example.rb}} is present.



was (Author: nafshartous):
`SKIP_API=1 jekyll build`  yields the error

{code}
  Dependency Error: Yikes! It looks like you don't have 
/home/nafshartous/Projects/spark/docs/_plugins/include_example.rb or one of its 
dependencies installed. In order to use Jekyll as currently configured, you'll 
need to install this gem. The full error message from Ruby is: 'cannot load 
such file -- pygments' If you run into trouble, you can find helpful resources 
at https://jekyllrb.com/help/! 
jekyll 3.4.0 | Error:  
/home/nafshartous/Projects/spark/docs/_plugins/include_example.rb
{code}

The file `_plugins/include_example.rb` is present.


> API Doc pages for Streaming with Kafka 0.10 not current
> ---
>
> Key: SPARK-19767
> URL: https://issues.apache.org/jira/browse/SPARK-19767
> Project: Spark
>  Issue Type: Bug
>  Components: Structured Streaming
>Affects Versions: 2.1.0
>Reporter: Nick
>Priority: Minor
>
> The API docs linked from the Spark Kafka 0.10 Integration page are not 
> current.  For instance, on the page
>https://spark.apache.org/docs/latest/streaming-kafka-0-10-integration.html
> the code examples show the new API (i.e. class ConsumerStrategies).  However, 
> following the links
> API Docs --> (Scala | Java)
> lead to API pages that do not have class ConsumerStrategies) .  The API doc 
> package names  also have {code}streaming.kafka{code} as opposed to 
> {code}streaming.kafka10{code} 
> as in the code examples on streaming-kafka-0-10-integration.html.  



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

-
To unsubscribe, e-mail: issues-unsubscr...@spark.apache.org
For additional commands, e-mail: issues-h...@spark.apache.org