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

Enhancements to the IPFS Pinning Services Documentation #1638

Merged
merged 17 commits into from
Aug 3, 2023

Conversation

kichen1984
Copy link
Contributor

@kichen1984 kichen1984 commented Jul 20, 2023

Describe your changes

This pull request introduces several updates to the IPFS Pinning Services documentation. The changes are primarily focused on the work-with-pinning-services.md file and related images.

Files changed

  • work-with-pinning-services.md: This file has been updated to include more detailed information about various pinning services, including the addition of Filebase to the list of services that support the IPFS Pinning Service API endpoint. The instructions for using these services have also been expanded and clarified.
  • add-service-filebase-token.png: This new image has been added to illustrate the process of obtaining a secret access token from Filebase.
  • add-service-picker.jpg: This image has been modified to better illustrate the process of selecting a pinning service.

What issue(s) does this address?

This pull request addresses the need for more comprehensive and up-to-date information about the available pinning services and how to use them. By providing clearer instructions and more relevant examples, it will make it easier for users to understand and utilize these services.

Does this update depend on any other PRs?

No

Checklist before requesting a review

  • Passing the beta version of the Check Markdown links for modified files check. Action results can be viewed here.

Checklist before merging

  • Passing all required checks (The beta Check Markdown links for modified files check is not required)

@welcome
Copy link

welcome bot commented Jul 20, 2023

Thank you for submitting this PR!
A maintainer will be here shortly to review it.
We are super grateful, but we are also overloaded! Help us by making sure that:

  • The context for this PR is clear, with relevant discussion, decisions and stakeholders linked/mentioned.
  • Your contribution itself is clear (grammar and spelling checked, any code blocks checked and commented) and in its best form. Follow the docs contribution guidelines if they apply.

Getting other community members to do a review would be great help too on complex PRs (you can ask in the chats/forums). If you are unsure about something, just leave us a comment.
Next steps:

  • A maintainer will triage and assign priority to this PR, commenting on any missing things and potentially assigning a reviewer for high priority items.
  • The PR gets reviews, discussed and approvals as needed.
  • The PR is merged by maintainers when it has been approved and comments addressed.

We currently aim to provide initial feedback/triaging within two business days. Please keep an eye on any labelling actions, as these will indicate priorities and status of your contribution.
We are very grateful for your contribution!

@kichen1984 kichen1984 marked this pull request as ready for review July 20, 2023 15:45
Copy link
Contributor

@ElPaisano ElPaisano left a comment

Choose a reason for hiding this comment

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

Thank you for submitting this PR. I've made a number of requested edits.

In addition, I am going to make some general modifications to this page to improve its navigability and readability.

docs/how-to/work-with-pinning-services.md Outdated Show resolved Hide resolved
docs/how-to/work-with-pinning-services.md Outdated Show resolved Hide resolved
docs/how-to/work-with-pinning-services.md Outdated Show resolved Hide resolved
docs/how-to/work-with-pinning-services.md Outdated Show resolved Hide resolved
@ElPaisano ElPaisano changed the base branch from main to stage August 3, 2023 19:13
@ElPaisano ElPaisano merged commit 425b482 into ipfs:stage Aug 3, 2023
2 of 5 checks passed
ElPaisano added a commit that referenced this pull request Aug 31, 2023
* Enhancements to the IPFS Pinning Services Documentation (#1638)

Co-authored-by: ElPaisano <[email protected]>
Co-authored-by: Kichen <[email protected]>
Co-authored-by: Russell Dempsey <[email protected]>
Co-authored-by: Marcin Rataj <[email protected]>
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