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

Sprint: Delightful Documentation #357

Closed
flyingzumwalt opened this Issue Jan 16, 2017 · 11 comments

Comments

Projects
None yet
10 participants
@flyingzumwalt
Copy link
Contributor

flyingzumwalt commented Jan 16, 2017

A major sprint with all core maintainers entirely focusing on Documentation for 2 weeks.

Objectives

  • Remove/delete/burn outdated documentation
  • Overview lists and diagrams for the whole IPFS stack
  • Code examples for all layers of the IPFS stack, and how they fit together
  • Overhauling examples on the website
  • Adding usage and API sections to current ipfs and libp2p modules
  • Checking all commands for ipfs cli tool
  • Working on examples for various modules and the system as a whole
  • Building a "take your data and use IPFS X" process doc for large institutions.
  • Rethinking organizational structures
  • Standardizing all organizations
  • Getting approval from all committers for licensing and patents - sign off's from before we had sign offs
  • Godoc for all go packages

Waffle board

https://waffle.io/ipfs/docs

Team for this Sprint

@Kubuxu, @diasdavid, @hsanjuan, @lgierth, @flyingzumwalt, @nicolagreco, @SidHarder (PM)

Dependencies

@flyingzumwalt

This comment has been minimized.

Copy link
Contributor Author

flyingzumwalt commented Jan 25, 2017

@flyingzumwalt

This comment has been minimized.

Copy link
Contributor Author

flyingzumwalt commented Feb 9, 2017

This sprint needs to also address the install experience. There's no point in having documentation if people can't install your software.

@lgierth lgierth referenced this issue Feb 21, 2017

Closed

Translation ? #164

@flyingzumwalt

This comment has been minimized.

Copy link
Contributor Author

flyingzumwalt commented Mar 10, 2017

This work is being tracked in the https://github.com/ipfs/docs/issues repository.

@lgierth

This comment has been minimized.

Copy link
Member

lgierth commented Mar 10, 2017

Sprint prep: ipfs/docs#20

@lgierth

This comment has been minimized.

Copy link
Member

lgierth commented Mar 10, 2017

@lgierth

This comment has been minimized.

Copy link
Member

lgierth commented Mar 10, 2017

I think I've updated the assigned people accordingly -- @victorbjelkholm @dignifiedquire @whyrusleeping please fix if neccessary :):)

@lgierth

This comment has been minimized.

Copy link
Member

lgierth commented Mar 10, 2017

I've updated the waffle board and assignments a bit, please feel free to reassign and reshuffle how you see fit.

@lgierth

This comment has been minimized.

Copy link
Member

lgierth commented Mar 15, 2017

docs sprint standup 15-Mar-2017

participants:

  • daviddias
  • hsanjuan
  • jaycarpenter
  • tomkorrison
  • lgierth
  • flyingzumwalt

updates:

  • daviddias
    • improved interface-ipfs-core spec
      • readme
      • polishing function documentation, at least one example for each
      • went through js-ipfs and js-ipfs-api and added links to function definitions
    • improved js-ipfs-init
      • simplified, removed cruft
      • one-step process, and three-step process
      • involved many code and docs changes
    • make adding webrtc/ws addresses easier
    • now: finishing js-ipfs tutorial
  • hsanjuan
    • wrote ipfs-update install guide
    • improved fs-repo-migrations docs
    • now: go-libp2p examples
    • now: golint on go-libp2p
    • next: more going through repos/packages
  • jaycarpenter
    • intro: involved in telecommunications, and north-american regulatory bodies, naming, addressing
    • reviewing various communication and documentation channels, @flyinzumwalt's write-up
    • working on documentation process proposal
    • participating in ipfs/docs#29
  • tomkorrison
  • lgierth
    • wrapping up go-ipfs core-api refinements
    • collected information for centralizing go-libp2p interfaces
      • not so convinced anymore
      • gonna let it rest for a few days
    • next: set up temporary trusted host for automatic website builds
  • flyingzumwalt
    • now: working on discourse decision, and decision-making process
    • next: making sure we're on the path to doing docs properly
  • kubuxu
    • "I can't join, sorry. As an update, I haven't done much with docs, mostly other work."

discussion:

  • more tasks for david? :)
    • how to start contributing
    • webrtc-star
    • ...
  • ...
@lgierth

This comment has been minimized.

@lgierth

This comment has been minimized.

Copy link
Member

lgierth commented Mar 22, 2017

Standups are Wednesday 4p UTC and Friday 4p UTC (just to prevent confusion)

That's 5p CET, dear other folks in central europe.

@lgierth

This comment has been minimized.

Copy link
Member

lgierth commented Mar 22, 2017

@daviddias daviddias closed this Sep 4, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment