Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: clarify use of provider hints #72

Merged
merged 14 commits into from
Feb 10, 2021
Merged

docs: clarify use of provider hints #72

merged 14 commits into from
Feb 10, 2021

Conversation

lidel
Copy link
Member

@lidel lidel commented Feb 10, 2021

This PR updates docs and examples related to origins and delegates multiaddr arrays:

  • makes it explicit that connection dials to origins and delegates are best-effort, and should not fail the pinning
  • swaps examples to use fully resolved multiaddrs, that can immediately be acted upon (IPs from test ranges defined in rfc5737)

Thanks to @obo20 for raising the ambiguity here – lmk if this clears things out.

- makes it explicit that connection dials to origins and delegates are
  best-effort, and should not fail the pinning
- swaps examples to use fully resolved multiaddrs, that can immediatelly
  be acted upon (IP ranges from test ranges
  (https://tools.ietf.org/html/rfc5737)
@lidel lidel requested review from jessicaschilling and a team February 10, 2021 13:01
Copy link
Contributor

@jessicaschilling jessicaschilling left a comment

Choose a reason for hiding this comment

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

Just some little style/grammar nits. Thanks!

ipfs-pinning-service.yaml Outdated Show resolved Hide resolved
ipfs-pinning-service.yaml Outdated Show resolved Hide resolved
ipfs-pinning-service.yaml Outdated Show resolved Hide resolved
ipfs-pinning-service.yaml Outdated Show resolved Hide resolved
ipfs-pinning-service.yaml Outdated Show resolved Hide resolved
ipfs-pinning-service.yaml Outdated Show resolved Hide resolved
ipfs-pinning-service.yaml Outdated Show resolved Hide resolved
ipfs-pinning-service.yaml Outdated Show resolved Hide resolved
ipfs-pinning-service.yaml Outdated Show resolved Hide resolved
ipfs-pinning-service.yaml Outdated Show resolved Hide resolved
lidel and others added 11 commits February 10, 2021 20:24
Co-authored-by: Jessica Schilling <[email protected]>
Co-authored-by: Jessica Schilling <[email protected]>
Co-authored-by: Jessica Schilling <[email protected]>
Co-authored-by: Jessica Schilling <[email protected]>
Co-authored-by: Jessica Schilling <[email protected]>
Co-authored-by: Jessica Schilling <[email protected]>
Co-authored-by: Jessica Schilling <[email protected]>
Co-authored-by: Jessica Schilling <[email protected]>
Co-authored-by: Jessica Schilling <[email protected]>
Co-authored-by: Jessica Schilling <[email protected]>
@lidel
Copy link
Member Author

lidel commented Feb 10, 2021

@jessicaschilling thank you, applied suggestions + made a small clarification in 84cec73 – mind taking a second look?

Copy link
Contributor

@jessicaschilling jessicaschilling left a comment

Choose a reason for hiding this comment

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

LGTM, thank you!

@lidel
Copy link
Member Author

lidel commented Feb 10, 2021

Merging as I got 👍 from @aschmahmann and @obo20 via a telepathic medium of a great accuracy.

@lidel lidel merged commit db3ceb8 into main Feb 10, 2021
@lidel lidel deleted the docs/provider-hints branch February 10, 2021 21:19
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.

2 participants