ambry icon indicating copy to clipboard operation
ambry copied to clipboard

No more documents

Open forkforlearn opened this issue 7 years ago • 3 comments

Undoubtedly, ambry is one of the most useful distributed storage systems. But i do not know why there is no more detailed documents (no more management documents, no more tools documentation)

forkforlearn avatar Jan 01 '18 15:01 forkforlearn

Fully agree that the wiki could be improved with more up-to-date documentation. Developers and reviewers have generally been diligent in ensuring that code is well documented and kept up to date, though. Is there anything in particular you need help with?

pnarayanan avatar Jan 02 '18 00:01 pnarayanan

@pnarayanan

I am very grateful the peoples who work hard on this project, without them there is no this project (And the project is so cool :) ). But I sincerely hope someone can update the contents of the wiki, for example: how to use tools to view ambry status(not only health) 、troubleshooting tips、 how to failover ... etc...

forkforlearn avatar Jan 02 '18 04:01 forkforlearn

A really good way to learn about Ambry (and it's tools) is by looking at the Javadoc in the code. For example if you look at the Javadoc of the main method of the HelixClusterWideAggregationTool there is a good deal of info on how to use the tool.

siepkes avatar Jan 02 '18 09:01 siepkes