Skip to content
This repository has been archived by the owner on Dec 20, 2024. It is now read-only.

docs: add more questions in FAQ.md #302

Merged
merged 1 commit into from
Jan 7, 2019

Conversation

allencloud
Copy link
Contributor

@allencloud allencloud commented Jan 5, 2019

Signed-off-by: Allen Sun [email protected]

Ⅰ. Describe what this PR did

FAQ is very important for end-users or developers to understand the project much better.
We have not sufficient question&answer in Dragonfly before.

Now I try to add more question&answer in FAQ.md.

If any reviewers or readers find that there should be more concrete questions there in FAQ.md, please do not hesitate to add question&answer in the file within a pull request, or in issue to request maintainers to add.

Ⅱ. Does this pull request fix one issue?

fix dragonflyoss/dragonfly#212
fix dragonflyoss/dragonfly#301 via question ## What is the policy of bandwidth limit in peer network

Ⅲ. Why don't you add test cases (unit test/integration test)? (你真的觉得不需要加测试吗?)

no need.

Ⅳ. Describe how to verify it

none

Ⅴ. Special notes for reviews

none

@pouchrobot pouchrobot added areas/docs kind/question all questions or confusion about this project size/L labels Jan 5, 2019
FAQ.md Outdated
- If file's total size is less than 200MB, then the piece size is `4MB` by default.
- Otherwise, it equals to `min{ totalSize/100MB + 2 MB, 15MB }`.

## What is the difference between Dragonfly's P2P algorithm and bit-torrent
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you help to answer this question? @garfield009 @lowzj
I think many peopler are curious about the answer.

@allencloud allencloud force-pushed the update-faq branch 4 times, most recently from f0528bf to b4aea07 Compare January 7, 2019 02:30
@codecov-io
Copy link

codecov-io commented Jan 7, 2019

Codecov Report

Merging #302 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #302   +/-   ##
=======================================
  Coverage   59.36%   59.36%           
=======================================
  Files          32       32           
  Lines        1831     1831           
=======================================
  Hits         1087     1087           
  Misses        703      703           
  Partials       41       41

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update eddcdba...ea60624. Read the comment docs.

@allencloud
Copy link
Contributor Author

Do we have any other frequently asked questions? If yes, please comment on this pr or submit prs to add them? @starnop @zhouhaibing089 @fengzixu @lowzj @garfield009
Thanks a lot.

@fengzixu
Copy link
Collaborator

fengzixu commented Jan 7, 2019

As you see, there are many issues about pushing or pulling the private image from the private registry. I suggest that we should add related info to the FAQ.md. It can help the maintainers and members to reduce the pressure of replying the same question. @allencloud

@allencloud allencloud force-pushed the update-faq branch 2 times, most recently from ea60624 to a8cfb88 Compare January 7, 2019 06:52
@allencloud
Copy link
Contributor Author

I suggest that we should add related info to the FAQ.md.

Good idea. @fengzixu
Now added.

@fengzixu
Copy link
Collaborator

fengzixu commented Jan 7, 2019

LGTM

- If file's total size is less than 200MB, then the piece size is `4MB` by default.
- Otherwise, it equals to `min{ totalSize/100MB + 2 MB, 15MB }`.

## What is the difference between Dragonfly's P2P algorithm and bit-torrent(BT)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@allencloud
Copy link
Contributor Author

LGTM

@pouchrobot pouchrobot added the LGTM one maintainer or community participant agrees to merge the pull reuqest. label Jan 7, 2019
@allencloud allencloud merged commit a13ad81 into dragonflyoss:master Jan 7, 2019
@allencloud allencloud deleted the update-faq branch January 7, 2019 08:58
starnop pushed a commit to starnop/Dragonfly that referenced this pull request Nov 27, 2019
sungjunyoung pushed a commit to sungjunyoung/Dragonfly that referenced this pull request May 8, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
areas/docs kind/question all questions or confusion about this project LGTM one maintainer or community participant agrees to merge the pull reuqest. size/L
Projects
None yet
4 participants