Skip to content
This repository was archived by the owner on Jun 2, 2020. It is now read-only.

Port existing docs content to beta-site repo #345

Closed
jessicaschilling opened this issue Oct 3, 2019 · 3 comments · Fixed by ipfs/ipfs-docs#10
Closed

Port existing docs content to beta-site repo #345

jessicaschilling opened this issue Oct 3, 2019 · 3 comments · Fixed by ipfs/ipfs-docs#10
Assignees
@cwaring @jessicaschilling @ericronne
Labels
dif/easy Someone with a little familiarity can pick up effort/days Estimated to take multiple days, but less than a week topic/design-content Content design, writing, information architecture
Milestone
PL internal demo PoC

Comments

@jessicaschilling
Copy link
Contributor

jessicaschilling commented Oct 3, 2019 •
edited
Loading

This issue is part of Epic 1A: Launch docs beta.

Port content from existing docs site repo to beta-site repo, adjusting or adding front matter and other metadata as necessary.
@jessicaschilling jessicaschilling added topic/design-content Content design, writing, information architecture dif/easy Someone with a little familiarity can pick up effort/days Estimated to take multiple days, but less than a week labels Oct 3, 2019
@jessicaschilling jessicaschilling changed the title Docs beta: port content Port existing docs content to beta-site repo Oct 4, 2019
@cwaring cwaring self-assigned this Oct 10, 2019
@ericronne
Copy link
Contributor

First we'll need a template …

Then we can portage the content 🛶…

  • Populate templates with all current docs content refer @ericronne / @jessicaschilling
    • What is IPFS?
    • How IPFS Works
    • Content-addressed file storage
    • Content addressing and CIDs
    • Cryptographic hashing
    • Persistence (pinning)
    • Merkle-DAGs
    • IPNS
    • libp2p
    • Mutable File System (MFS)
    • UnixFS
    • IPFS Gateway
    • DNSLink
    • Configure a node
    • Modify the peers list
    • Customize an ipfs repo (js-ipfs)⬈
    • Spawn a node and add a file to IPFS (js-ipfs)⬈
    • Deal with blocks
    • Pin files
    • Troubleshoot file transfers ⬈
    • Snapshots
    • Host a Git-style repo
    • Store and play videos
    • Resolve through IPLD graphs (js-ipfs) ⬈
    • Replicate large datasets ⬈
    • Observing peers
    • Circuit relay (js-ipfs) ⬈
    • Customize libp2p bundles (js-ipfs) ⬈
    • Host a website on IPFS
    • Explore the Ethereum blockchain with IPFS (js-ipfs) ⬈
    • Making Your Own IPFS Service (basic egs)
    • Developing Apps with the IPFS API ⬈
    • Solving distributed networking problems with libp2p ⬈
    • Addressing in browsers ⬈
    • Build a tiny browser app to exchange files between nodes ⬈
    • Build an application with IPFS PubSub Room 📹 ⬈
    • Build a collaborative editing application using CRDT 📹 ⬈
    • Stream video using ReadableStreams ⬈
    • Browserify ⬈
    • Parcel.js ⬈
    • Vue ⬈
    • WebPack ⬈
    • With a <script> tag ⬈
    • Electron ⬈
    • The Mutable File System in the browser (js-ipfs) ⬈
    • Using streams to add directories to ipfs in the browser (js-ipfs) ⬈
    • HTTP API dictionary (this may need to be separated by go and js)
    • Working with go-IPFS
    • api dictionary
    • core options API dictionary
    • coreiface API dictionary
    • core API dictionary
    • Working with IPFS in JS
    • JS core API dictionary ⬈
    • js-ipfs-api dictionary ⬈
    • CLI commands (this may need to be separated by go and js)
    • Forums ⬈
    • IRC
    • Community calls (& cal)
    • Meetups
    • ProtoSchool chapters
    • Community projects: Awesome IPFS ⬈
    • Contribute to IPFS
    • Code of conduct ⬈
    • Project & roadmap
    • IPFS specifications ⬈
    • Roadmap ⬈
    • IPFS team planning/management repo ⬈

@jessicaschilling jessicaschilling added this to the Lab Week 2019 PoC milestone Oct 17, 2019
jessicaschilling added a commit to ipfs/ipfs-docs that referenced this issue Oct 28, 2019
@jessicaschilling
Added external links to left nav menu items
7f1238d 
Added internal pages for history (temporary) and web addressing (omitted 
earlier)
ref ipfs-inactive/docs#345
This was referenced Oct 28, 2019
Merged
Merged
Merged
@jessicaschilling
Copy link
Contributor Author

  • Migrated existing content
  • Rearranged and reformatted as necessary to fit new IA
  • Fixed all relative links
  • Cleaned up a lot of miscellaneous typos, formatting issues, outdated links that I found along the way.

The beta site should be ready for a close-read audit now. Closing this issue!

@cwaring
Copy link
Collaborator

cwaring commented Nov 1, 2019

Superb milestone! Thanks for all you help getting this migrated 🙌💯

@jessicaschilling jessicaschilling mentioned this issue Jan 6, 2020
Closed
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@cwaring cwaring

@jessicaschilling jessicaschilling

@ericronne ericronne

Labels
dif/easy Someone with a little familiarity can pick up effort/days Estimated to take multiple days, but less than a week topic/design-content Content design, writing, information architecture
Projects
None yet
Milestone
PL internal demo PoC
Development

Successfully merging a pull request may close this issue.

Migrate all the things ipfs/ipfs-docs
3 participants
@cwaring @jessicaschilling @ericronne