Skip to content

[STORM-557] Created docs directory and added in some svg diagrams.#314

Merged
asfgit merged 2 commits intoapache:masterfrom
revans2:STORM-557
Mar 2, 2015
Merged

[STORM-557] Created docs directory and added in some svg diagrams.#314
asfgit merged 2 commits intoapache:masterfrom
revans2:STORM-557

Conversation

@revans2
Copy link
Contributor

@revans2 revans2 commented Nov 14, 2014

No description provided.

@harshach
Copy link
Contributor

+1

@HeartSaVioR
Copy link
Contributor

Amazing for sharing high-res svg diagrams! Thanks!

@revans2
Copy link
Contributor Author

revans2 commented Nov 17, 2014

I was curious if we wanted to keep a 5MB file in our github repo that everyone must download to get storm? As it stands now the git repo is about 11MB total. This could slow things down for some developers. It might be better to put it in the SVN repo with the web page source

http://svn.apache.org/viewvc/storm/

But it would make it less accessible to developers who might want to reuse it.

@harshach
Copy link
Contributor

@revans2 There is another JIRA asking for the current storm.apache.org docs to be moved onto github.
https://issues.apache.org/jira/browse/STORM-544.
As @HeartSaVioR pointed out about redis-doc https://github.com/antirez/redis-doc. I am +1 on moving all storm related doc onto its own github repo. Makes it easier for community to contribute to the docs.

@revans2
Copy link
Contributor Author

revans2 commented Nov 17, 2014

OK so the next question I have is, should we split the one big SVG file up along side rasterized PNG equivalents for use in the docs?

@harshach
Copy link
Contributor

@revans2 sounds like a good idea to provide PNG files.

@revans2
Copy link
Contributor Author

revans2 commented Nov 17, 2014

OK I split them apart, cleaned up one of the SVG images to make it smaller, and added in some PNG versions, along with updating the security document to use one of the PNG images. So now the total new size is 3.6 MB. Hopefully a lot more people will find these useful.

@revans2
Copy link
Contributor Author

revans2 commented Dec 5, 2014

With pull #330 now up, I will wait for it to go in, and then rebase my changes on top of it.

@harshach
Copy link
Contributor

@revans2 can you please upmerge your patch. Thanks.

@revans2
Copy link
Contributor Author

revans2 commented Dec 22, 2014

Enough changed with the docs update, that I opted to just add the images in. If we want to move some of the other markdown documents over we can, but for now I just left them where they were.

@kishorvpatil
Copy link
Contributor

+1

@asfgit asfgit merged commit 28eb65d into apache:master Mar 2, 2015
@kishorvpatil
Copy link
Contributor

Thank you @revans2.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants