Tencent / Firestorm

Firestorm is a Remote Shuffle Service, and provides the capability for Apache Spark and Apache Hadoop MapReduce applications to store shuffle data on remote servers
Other
252 stars 72 forks source link

[Improvement] Move detailed client configuration to individual doc #201

Closed frankliee closed 2 years ago

frankliee commented 2 years ago

What changes were proposed in this pull request?

  1. Put detailed configuration to doc subdirectory.
  2. Add doc for client quorum setting.

Why are the changes needed?

Update doc

Does this PR introduce any user-facing change?

No.

How was this patch tested?

Just doc.

colinmjj commented 2 years ago

@frankliee Add a section to describe how to use this feature with config?

frankliee commented 2 years ago

@frankliee Add a section to describe how to use this feature with config?

OK

jerryshao commented 2 years ago

I would suggest not add everything to readme, instead trying to use docs for the details. please think about it. CC @colinmjj

colinmjj commented 2 years ago

I would suggest not add everything to readme, instead trying to use docs for the details. please think about it. CC @colinmjj

Yes, there should be docs for new comer to know & use Firestorm better.

frankliee commented 2 years ago

I would suggest not add everything to readme, instead trying to use docs for the details. please think about it. CC @colinmjj

I will push a new PR that contains TOC and separated docs about client/server/coordinator.

jerqi commented 2 years ago

LGTM.