-
Notifications
You must be signed in to change notification settings - Fork 428
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: remote pinning services #369
Conversation
@lidel and @rafaelramalho19 -- here's a rough first pass at what I'm thinking the docs footprint of pinning service integration will be. Note that this is only one page, and that page addresses both how to add a pinning service in Desktop/Web UI as well as roll your own pinning service -- which I suspect will be enough, since the guidance doesn't sound like it'll be much more detailed than "do what you want to, but be sure to obey the API spec". Would love to hear your thoughts on whether you agree/disagree at this point though, as well as any other thoughts in general. Preview here, plus amendments to existing pin page in docs here. @johnnymatthews -- just adding you for context at this point, so you know what's in the pipeline. 😊 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Having a single doc on remote pinning services is a good call 👍
Sidenote: we will expand pin-files.md
with commands for remote pins after relevand changes land in go-ipfs.
@lidel - sounds good! @rafaelramalho19 - I think we're therefore safe to use https://docs.ipfs.io/how-to/work-with-pinning-services/ as our docs link 😊 |
Just one tiny change and then it's all good from me! Feel free to merge when ready :) |
Co-authored-by: Johnny <[email protected]>
@jessicaschilling is this ready to be merged in? |
Not for a bit yet 😊 will keep you posted! |
No worries. I'm just gonna mark this PR as a draft for now then :) |
@johnnymatthews @lidel @autonome -- this isn't quite ready to ship but requesting your review on the text so we can keep this moving in preparation for go-live. IMPORTANT NOTE: Images are just FPO from this autumn's mockups, and will be replaced with real screenshots once we've finished wiring up ipfs-webui. |
Made a few changes, mainly formatting. Stuff the reader needs to click on or read should be in bold:
I tend to stay away from using parenthesis as much as possible. They don't play well with language translators, and can often be split up into multiple sentences pretty easily. Also, via is a weird word that language translators can't deal with, so I tend to use through or using, stuff like that. Outside of that, I like this PR! Merge when ready. |
Co-authored-by: Johnny <[email protected]>
Co-authored-by: Johnny <[email protected]>
Co-authored-by: Johnny <[email protected]>
Co-authored-by: Johnny <[email protected]>
Co-authored-by: Johnny <[email protected]>
Co-authored-by: Johnny <[email protected]>
Co-authored-by: Johnny <[email protected]>
Co-authored-by: Johnny <[email protected]>
Co-authored-by: Johnny <[email protected]>
Co-authored-by: Johnny <[email protected]>
Co-authored-by: Johnny <[email protected]>
Co-authored-by: Johnny <[email protected]>
Co-authored-by: Johnny <[email protected]>
Co-authored-by: Johnny <[email protected]>
Co-authored-by: Johnny <[email protected]>
Co-authored-by: Johnny <[email protected]>
Co-authored-by: Johnny <[email protected]>
Thanks for the detailed review, @johnnymatthews! Will remember the overall guidance for future work - thanks for the info. |
@jessicaschilling I made a pass at this in cb629c7
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, but we need to confirm link to Pinata docs works before merging this.
cc @obo20
@lidel In hindsight this was probably not the best way for me to do it, but I left a few comments on your commit cb629c7. Let me know if you'd rather me just duplicate those as a review. One note: @johnnymatthews has a periodic release cadence going on for docs now, so ping him before you merge. 😊 Thank you! |
@jessicaschilling comments on commit were fine, thank you! I removed mention of "porcelain" – indeed this is a bit niche technical term (as in Git Internals - Plumbing and Porcelain), better to not add to the pile for now (digression: I argue that IPFS has a lot of plumbing, but not enough porcelain). Mind eyeballing my changes in 5896c56 before I summon Johnny? |
@lidel LGTM, thank you! |
@johnnymatthews https://github.com/ipfs/go-ipfs/releases/v0.8.0 is tagged and people will start looking into this now, so I'm merging. |
This PR makes room in docs for info related to pinning service integration in IPFS Desktop/Web UI:
WIP! Using this PR to iterate on the content that will need to appear on these pages. Please do not merge until pinning service integration is ready to go live.