Skip to content
This repository has been archived by the owner on Apr 16, 2021. It is now read-only.

Announce IPFS Companion 2.2.0 #156

Merged
merged 3 commits into from
Apr 12, 2018
Merged

Conversation

lidel
Copy link
Collaborator

@lidel lidel commented Apr 10, 2018

Draft of a post announcing IPFS Companion v2.2.0.

Rendered Preview @ 2b65cc7

  • Needs proof-read
  • Highlights for two key features + link to long release notes
  • I embedded a short and sweet demo of window.ipfs by @alanshaw
  • Used non-tracking embedd for the youtube player + a tiny trick to make player follow reflow of responsive layout
  • Are the above okay?

cc @alanshaw @olizilla

@ghost ghost added the stage: skeleton label Apr 10, 2018

![demo of v2.2.0](https://ipfs.io/ipfs/QmdJTmCxwcpoGbEVfT6b9j4RZJWNcF2GQG1Ajf9XB6XtVP)

Why is it worth a blog post you ask? See the overview of key features below.
Copy link
Contributor

Choose a reason for hiding this comment

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

Why is it worth a blog post you ask?

No need to be too humble about it, the extension is rad. I'd drop that part.

author: lidel
---

I am pleased to announce to everyone in our community that a new version of our
Copy link
Contributor

Choose a reason for hiding this comment

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

You're using us and we in the rest of the post, so this should probably changed to be the same.


### Your node is exposed as `window.ipfs` on every webpage

Websites can now detect if the property exists in window context and opt-in to
Copy link
Contributor

Choose a reason for hiding this comment

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

Might be worth adding a note that window.ipfs exposes the same api as js-ipfs-api, and that we'd like to see people building apps that use it, perhaps with a link to one of the demos.

Copy link
Collaborator Author

@lidel lidel Apr 10, 2018

Choose a reason for hiding this comment

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

This part is bit tricky for me. AFAIK we want window.ipfs to be compatible with ipfs/interface-ipfs-core/, not a specific backend.

Maybe @alanshaw can help with wording it in a honest way?
See ipfs-inactive/ipfs-postmsg-proxy#18

Copy link
Contributor

Choose a reason for hiding this comment

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

It's correct that window.ipfs exposes the same API as js-ipfs-api so it's fine to say that, and it might be easier for people to understand.

It's more correct to say that it exposes an interface-ipfs-core compatible interface, but not everyone will know what that is. Note, js-ipfs-api exposes a interface-ipfs-core compatible interface too.

I also think it's ok to say it exposes the same API as js-ipfs-api since you'll only be using window.ipfs from JS anyway.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

2b65cc7 (preview) plays it safe by glossing over it like this:

The API aims to be compatible with interface-ipfs-core, which means websites can now detect if the property exists in window context and opt-in to use it instead of creating their own js-ipfs node.

Is it ok? (added links to demos at the end of section as well)

@lidel lidel changed the title Announce IPFS Companion 2.2.0 [WIP] Announce IPFS Companion 2.2.0 Apr 10, 2018
@lidel lidel changed the title [WIP] Announce IPFS Companion 2.2.0 Announce IPFS Companion 2.2.0 Apr 11, 2018
@lidel
Copy link
Collaborator Author

lidel commented Apr 11, 2018

What is the next step?
Merge? Who can merge this? @victorbjelkholm ? :)

@victorb
Copy link
Contributor

victorb commented Apr 12, 2018

@lidel feel free to merge whenever you feel it's ready to be published and shared with the world :) Once in master, it'll be deployed to the live website.

@lidel
Copy link
Collaborator Author

lidel commented Apr 12, 2018

There is a small problem: I don't see "merge" button :)
I don't have required permissions to this repo.

@lidel lidel merged commit b383bef into ipfs-inactive:master Apr 12, 2018
@ghost ghost removed the stage: skeleton label Apr 12, 2018
@lidel lidel deleted the ipfs-companion-2.2.0 branch April 12, 2018 09:26
@victorb
Copy link
Contributor

victorb commented Apr 12, 2018

Fixed the permissions and I can tell you already saw it! 🥇

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants