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

Add warning about js-ipfs being discontinued / point to Helia in a few places #1466

Merged
merged 3 commits into from
Feb 1, 2023

Conversation

ElPaisano
Copy link
Contributor

Describe your changes

Addresses #1465 and Part 1 of issue 1459

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)

@ElPaisano ElPaisano changed the title Add warning about js-ipfs being discontinued in a few places Add warning about js-ipfs being discontinued / point to Helia in a few places Jan 30, 2023
@ElPaisano
Copy link
Contributor Author

ElPaisano commented Jan 30, 2023

@ElPaisano ElPaisano requested a review from 2color January 30, 2023 23:35
@ElPaisano ElPaisano linked an issue Jan 30, 2023 that may be closed by this pull request
@ElPaisano ElPaisano added this to the 1/27/23 - 2/3/23 milestone Jan 30, 2023
@ElPaisano ElPaisano self-assigned this Jan 30, 2023
@@ -5,6 +5,13 @@ description: "There isn't just one canonical IPFS implementation. Learn about th

# IPFS Implementations

:::warning js-ipfs being discontinued
Development of the [js-ipfs project](https://github.com/ipfs/js-ipfs) is being discontinued to focus on [Helia](https://github.com/ipfs/helia), a leaner, more modular, modern implementation of IPFS in JavaScript slated for release in 2023. To learn more about Helia and the current state of IPFS in JS, see the [blog post](https://blog.ipfs.tech/state-of-ipfs-in-js/).
Copy link
Member

Choose a reason for hiding this comment

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

I would move this either to below the table or into the js-ipfs row so it's not the first thing you read on the page.

Also, this is the first time I've seen slated used this way. Looking it up reveals that it's a north American word which probably explains why I haven't seen it. What do you think about a more neutral verb, e.g. scheduled or planned?

Copy link
Member

@2color 2color left a comment

Choose a reason for hiding this comment

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

The new warning element itself is great.

I would also add it to the following pages:

@2color
Copy link
Member

2color commented Feb 1, 2023

Either here or in a separate PR, e.g. #1360, we should add Helia to the list of implementation

@ElPaisano
Copy link
Contributor Author

ElPaisano commented Feb 1, 2023

Either here or in a separate PR, e.g. #1360, we should add Helia to the list of implementations

👍 made a note to address it as part of #1465, will create a quick PR

@ElPaisano ElPaisano merged commit 2de9ad9 into ipfs:main Feb 1, 2023
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.

js-ipfs docs-wide improvements
2 participants