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: remote pinning services #369

Merged
merged 29 commits into from
Feb 19, 2021
Merged

docs: remote pinning services #369

merged 29 commits into from
Feb 19, 2021

Conversation

jessicaschilling
Copy link
Contributor

This PR makes room in docs for info related to pinning service integration in IPFS Desktop/Web UI:

  • Adds new page at /how-to/work-with-pinning-services/
  • Adds new page to left-hand nav
  • Amends existing pinning page at /how-to/pin-files/

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.

@jessicaschilling
Copy link
Contributor Author

@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. 😊

Copy link
Member

@lidel lidel left a 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.

@jessicaschilling
Copy link
Contributor Author

@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 😊

@johnnymatthews
Copy link
Contributor

johnnymatthews commented Jul 15, 2020

Just one tiny change and then it's all good from me! Feel free to merge when ready :)

@johnnymatthews
Copy link
Contributor

@jessicaschilling is this ready to be merged in?

@jessicaschilling
Copy link
Contributor Author

Not for a bit yet 😊 will keep you posted!

@johnnymatthews
Copy link
Contributor

No worries. I'm just gonna mark this PR as a draft for now then :)

@johnnymatthews johnnymatthews marked this pull request as draft July 24, 2020 14:08
@jessicaschilling jessicaschilling marked this pull request as ready for review December 18, 2020 00:21
@jessicaschilling
Copy link
Contributor Author

@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.

@johnnymatthews
Copy link
Contributor

Made a few changes, mainly formatting.

Stuff the reader needs to click on or read should be in bold:

  • Click Pin file.
  • Go to Settings and click Reset.

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.

@jessicaschilling
Copy link
Contributor Author

Thanks for the detailed review, @johnnymatthews! Will remember the overall guidance for future work - thanks for the info.

Base automatically changed from master to main January 12, 2021 16:07
@lidel
Copy link
Member

lidel commented Feb 17, 2021

@jessicaschilling I made a pass at this in cb629c7

@lidel lidel changed the title [WIP] Add pinning service info to docs docs: remote pinning services Feb 17, 2021
Copy link
Member

@lidel lidel left a 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 lidel requested a review from aschmahmann February 17, 2021 23:45
@jessicaschilling
Copy link
Contributor Author

@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!

@lidel
Copy link
Member

lidel commented Feb 18, 2021

@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?

@jessicaschilling
Copy link
Contributor Author

@lidel LGTM, thank you!

@lidel lidel requested a review from johnnymatthews February 18, 2021 14:27
@lidel
Copy link
Member

lidel commented Feb 19, 2021

@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.

@lidel lidel merged commit b18f003 into main Feb 19, 2021
@lidel lidel deleted the feat/pinning-services branch February 19, 2021 22:30
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.

3 participants