[ 
https://issues.apache.org/jira/browse/STORM-544?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Jungtaek Lim updated STORM-544:
-------------------------------
    Description: 
Actually I've mailed this to Storm Dev mailing list, but nobody cares so I 
repost it to JIRA.

I found that some documents are outdated.

1. 
storm-starter link from all (or most? I don't know) documents refers to 
https://github.com/nathanmarz/storm-starter, it should be 
https://github.com/apache/storm/tree/master/examples/storm-starter .

2. 
It seems that Storm project (including storm-starter) no longer uses Leiningen, 
right?
It it does, some documents should reflect that change.

- https://storm.apache.org/documentation/Creating-a-new-Storm-project.html

says that storm project uses Leiningen yet.

3. https://storm.apache.org/documentation/Maven.html contains outdated contents.

- It should reflect recent stable version of groupId and artifactId, and 
version.
- Would it better to remove building user's project with Leiningen because 
Storm project doesn't use Leiningen?
- "Developing Storm" section is completely outdated.

4. https://storm.apache.org/documentation/Maven.html

Markdown for code block is not working. xml tag is removed so we can't 
understand what it means.

5. Some repository links refer to incubator-storm, not storm.

6. multilang documents are outdated

a. Explanation for adapters is outdated. 
Storm have javascript implemenation so it doesn't need to rely on external, and 
many projects seems not maintained, or redirect us to forked project.
b. multilang-protocol is outdated.
- Spout subprocess can take a sleep in next() but shouldn't much because of 
heartbeat check.
- Bolt subprocess should handle heartbeat tuple, and send sync to let ShellBolt 
know it's alive. 

7. Storm-kafka project is in Storm project now, not storm-contrib.

I'll be happy to contribute when modification needs a hand.

  was:
Actually I've mailed this to Storm Dev mailing list, but nobody cares so I 
repost it to JIRA.

I found that some documents are outdated.

1. 
storm-starter link from all (or most? I don't know) documents refers to 
https://github.com/nathanmarz/storm-starter, it should be 
https://github.com/apache/storm/tree/master/examples/storm-starter .

2. 
It seems that Storm project (including storm-starter) no longer uses Leiningen, 
right?
It it does, some documents should reflect that change.

- https://storm.apache.org/documentation/Creating-a-new-Storm-project.html

says that storm project uses Leiningen yet.

3. https://storm.apache.org/documentation/Maven.html contains outdated contents.

- It should reflect recent stable version of groupId and artifactId, and 
version.
- Would it better to remove building user's project with Leiningen because 
Storm project doesn't use Leiningen?
- "Developing Storm" section is completely outdated.

4. https://storm.apache.org/documentation/Maven.html

Markdown for code block is not working. xml tag is removed so we can't 
understand what it means.

5. Some repository links refer to incubator-storm, not storm.

6. multilang documents are outdated

a. Explanation for adapters is outdated. 
Storm have javascript implemenation so it doesn't need to rely on external, and 
many projects seems not maintained, or redirect us to forked project.
b. multilang-protocol is outdated.
- Spout subprocess can take a sleep in next() but shouldn't much because of 
heartbeat check.
- Bolt subprocess should handle heartbeat tuple, and send sync to let ShellBolt 
know it's alive. 

I'll be happy to contribute when modification needs a hand.


> Some documents from website are outdated
> ----------------------------------------
>
>                 Key: STORM-544
>                 URL: https://issues.apache.org/jira/browse/STORM-544
>             Project: Apache Storm
>          Issue Type: Documentation
>            Reporter: Jungtaek Lim
>            Assignee: P. Taylor Goetz
>
> Actually I've mailed this to Storm Dev mailing list, but nobody cares so I 
> repost it to JIRA.
> I found that some documents are outdated.
> 1. 
> storm-starter link from all (or most? I don't know) documents refers to 
> https://github.com/nathanmarz/storm-starter, it should be 
> https://github.com/apache/storm/tree/master/examples/storm-starter .
> 2. 
> It seems that Storm project (including storm-starter) no longer uses 
> Leiningen, right?
> It it does, some documents should reflect that change.
> - https://storm.apache.org/documentation/Creating-a-new-Storm-project.html
> says that storm project uses Leiningen yet.
> 3. https://storm.apache.org/documentation/Maven.html contains outdated 
> contents.
> - It should reflect recent stable version of groupId and artifactId, and 
> version.
> - Would it better to remove building user's project with Leiningen because 
> Storm project doesn't use Leiningen?
> - "Developing Storm" section is completely outdated.
> 4. https://storm.apache.org/documentation/Maven.html
> Markdown for code block is not working. xml tag is removed so we can't 
> understand what it means.
> 5. Some repository links refer to incubator-storm, not storm.
> 6. multilang documents are outdated
> a. Explanation for adapters is outdated. 
> Storm have javascript implemenation so it doesn't need to rely on external, 
> and many projects seems not maintained, or redirect us to forked project.
> b. multilang-protocol is outdated.
> - Spout subprocess can take a sleep in next() but shouldn't much because of 
> heartbeat check.
> - Bolt subprocess should handle heartbeat tuple, and send sync to let 
> ShellBolt know it's alive. 
> 7. Storm-kafka project is in Storm project now, not storm-contrib.
> I'll be happy to contribute when modification needs a hand.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Reply via email to