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 links from IPFS & IPLD docs & websites to ProtoSchool #260

Closed
terichadbourne opened this issue Jul 11, 2019 · 8 comments
Closed

Add links from IPFS & IPLD docs & websites to ProtoSchool #260

terichadbourne opened this issue Jul 11, 2019 · 8 comments
Labels
docs-ipfs In scope for IPFS Docs Working Group OKR-2019-Q3 P0 - Critical

Comments

@terichadbourne
Copy link
Member

Need to review the documentation that exists on IPFS / IPLD sites for topics already covered by ProtoSchool tutorials and link to ProtoSchool where appropriate. This will be primarily in IPFS Files API and IPFS DAG API documentation.

terichadbourne added a commit to ipfs-inactive/interface-js-ipfs-core that referenced this issue Jul 15, 2019
- Change bullet formatting to make it possible to use the markdown headers to link specifically to the MFS portion of this document. 
- Link out from MFS section to the ProtoSchool tutorial as part of Q3 IPFS Docs initiative (see issue ProtoSchool/protoschool.github.io#260)
terichadbourne added a commit to ipfs-inactive/js-ipfs-http-client that referenced this issue Jul 15, 2019
Link to relevant MFS and DAG API tutorials on ProtoSchool, as part of the Q3 IPFS Docs task force efforts. See issue ProtoSchool/protoschool.github.io#260
terichadbourne added a commit to ipfs-inactive/interface-js-ipfs-core that referenced this issue Jul 15, 2019
Add links from existing docs to ProtoSchool tutorials as part of our Q3 IPFS Docs effort. See issue: ProtoSchool/protoschool.github.io#260
@terichadbourne
Copy link
Member Author

@alanshaw I've put in PRs to link from the DAG API and Files API docs, as well as the summary of all the APIs. (See above for links to those PRs in relevant repos.) Can you think of other spots in current docs where either API is explained that should be updated as well?

terichadbourne added a commit to terichadbourne/ipld that referenced this issue Jul 15, 2019
Adding links to relevant IPFS DAG API tutorials on ProtoSchool. Part of this Q3 IPFS Docs issue: ProtoSchool/protoschool.github.io#260

Once we separate the Decentralized Data Structures tutorial I'd link to the Merkle DAG one here as well.
@terichadbourne
Copy link
Member Author

@mikeal I added a PR to IPLD to include links to relevant ProtoSchool tutorials on the IPFS DAG API, but I don't have any rights in that repo so wasn't able to tag you as a reviewer. Mind taking a look? ipld/ipld#77

Please let me know if you can think of other spots across IPLD repos where such links would be appropriate (I already added to IPFS DAG API docs).

@alanshaw
Copy link
Member

What about linking to protoschool from ipfs.io and js.ipfs.io?

alanshaw pushed a commit to ipfs-inactive/interface-js-ipfs-core that referenced this issue Jul 16, 2019
Add links from existing docs to ProtoSchool tutorials as part of our Q3 IPFS Docs effort. See issue: ProtoSchool/protoschool.github.io#260
alanshaw pushed a commit to ipfs-inactive/js-ipfs-http-client that referenced this issue Jul 16, 2019
Link to relevant MFS and DAG API tutorials on ProtoSchool, as part of the Q3 IPFS Docs task force efforts. See issue ProtoSchool/protoschool.github.io#260
alanshaw pushed a commit to ipfs-inactive/interface-js-ipfs-core that referenced this issue Jul 17, 2019
- Change bullet formatting to make it possible to use the markdown headers to link specifically to the MFS portion of this document. 
- Link out from MFS section to the ProtoSchool tutorial as part of Q3 IPFS Docs initiative (see issue ProtoSchool/protoschool.github.io#260)
@terichadbourne
Copy link
Member Author

What about linking to protoschool from ipfs.io and js.ipfs.io?

@alanshaw @olizilla Any specific thoughts on the best place to highlight ProtoSchool on ipfs.io? One thought I've had is adding a second button here that would be something like "Explore ProtoSchool tutorials":

image

The footer's another option but it already feels overcrowded to me:
image

For js.ipfs.io, one option is to add the ProtoSchool tutorials to the list here so that people will find it if they hit the Tutorials tab:
image

Another would be to change "Try it out below!" to "Try it out below or explore our tutorials on ProtoSchool!" with an in-line link:
image

Any suggestions before I start a PR?

@mikeal Would you like ProtoSchool linked from ipld.io as well? Suggestions on where it would be most appropriate / least disruptive?

@terichadbourne terichadbourne changed the title Add links from IPFS & IPLD docs to ProtoSchool Add links from IPFS & IPLD docs & websites to ProtoSchool Jul 25, 2019
@terichadbourne terichadbourne added the docs-ipfs In scope for IPFS Docs Working Group label Jul 25, 2019
@terichadbourne
Copy link
Member Author

We've now merged all of our PRs across multiple repos to add links to ProtoSchool from ipfs.io, js.ipfs.io, IPFS API docs and example repos, and IPLD examples repo. (Easiest way to see these edits is to scroll up and click the links to issues next to the purple "merged" labels.)

@mikeal Would you like anything from the IPLD website itself? (Nothing pops out at me as the perfect spot to insert it but I'd be happy to brainstorm with you.)

I've leave this issue open until Wednesday to collect any more suggestions for IPFS/IPLD sites/resources to link to ProtoSchool from. If nothing else appears I'll close this out and we can add new issues for further suggestions. As we create new tutorials and edit existing ones, we'll make a point of updating inbound links where appropriate.

@mikeal
Copy link
Member

mikeal commented Aug 12, 2019

sigh

I don’t think anyone right now is happy with the IPLD website but we haven’t prioritized doing anything about it this quarter. I also don’t see a good place for it but, knowing that we’re overdue for a redesign, I think the best thing to do is log an issue in the repo about this and we’ll add it to the list of things to make sure we consider in the next version of the site.

@terichadbourne
Copy link
Member Author

Thanks, @mikeal. I've logged an issue for the IPLD website here: ipld/website#60

@terichadbourne
Copy link
Member Author

Closing this issue based on the merged work completed across a variety of sites/repos:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs-ipfs In scope for IPFS Docs Working Group OKR-2019-Q3 P0 - Critical
Projects
None yet
Development

No branches or pull requests

3 participants