Skip to content

Latest commit

 

History

History
101 lines (62 loc) · 8.38 KB

README.md

File metadata and controls

101 lines (62 loc) · 8.38 KB
Raw

IPFS Documentation Build status icon. Made by icon. Project icon.

This repository organizes overall documentation issues across the IPFS project. It's also home to the codebase for the legacy IPFS documentation site (available at docs.ipfs.io). The code for the current (beta) version of IPFS documentation is available at github.com/ipfs/ipfs-docs-v2, and all work on IPFS docs features OR content should be done there. Once we fully deprecate the legacy site, we'll move the beta codebase into this repo.

Join our monthly sync

Every month the team gets together to discuss plans for the coming four-ish weeks. This meeting usually happens on the last Tuesday of each month. Feel free to join us using 614386160 as the Zoom meeting ID! Here are the details for the next meeting:

Date Time Zoom ID Link Notes
Tuesday 28th April 2020 UTC: 16:00 - 16:30
EST: 11:00 - 11:30
PST 08:00-08:30
Unix: 1588089600		 614386160 protocol.zoom.us/j/614386160 Meeting notes

If you can't make the meeting, don't worry. We post a recording of each meeting in our YouTube playlist. Notes from current and past calls can be found here.

Get involved

We would love ❤️ your help to improve existing items or make new ones even better! We also have bounties available! Here are some ideas to get you started:

  1. Join us on our weekly call! See the top of this readme for full details on how and when.

  2. Claim an issue labeled "help wanted" in either this docs repo or the IPFS website repo! All our issues are T-shirt sized and roughly difficulty-graded (both using labels), so have a look for something that interests you in the time you have available, and dive on in! Leave your thoughts and questions in issue comments, and we'll get back to you as soon as possible.

  3. Create (or improve) an example, tutorial or concept guide! At present, we have a variety of how-tos and concept guides available at docs-beta.ipfs.io. However, every new item we can offer makes it easier for the world's community to use and build on IPFS. If you'd like to write a new example/tutorial or concept guide, take a look in our open issues for items with the Category: Content label and see if any already-identified needs appeal to you. Note that some issues may have bounties! If you'd like to write something entirely new, feel free — PRs are welcome! Or, if you'd just like to improve existing docs content, feel free to fork it and add your suggestions.

  4. Help us improve how we present reference and API documentation. In Q2 2020, we're investigating the best way to improve how we present reference materials like API documentation and command-line dictionaries. Got thoughts? Please discuss them!

If you're able to contribute to any of the categories above, we thank you in advance -- your work directly improves the future of IPFS for the global community! Before posting a PR with your changes, please be sure to check our documentation style guide and the overall IPFS contributor guidelines so we can ensure that docs are clear, consistent, and simple to read. Finally, please make sure to follow the IPFS code of conduct.

Issues

If you find something wrong within this repository, please raise an issue here.

IPFS Docs beta

Issues regarding the new IPFS Docs beta website should be raised in this repository's issue tracker. The Issues tab has been disabled in the ipfs/ipfs-docs-v2 repository to stop issues being posted there. The content of ipfs/ipfs-docs-v2 will be merged with the content of this repository in quarter 2 of 2020. We could completely delete the ipfs/docs repository and replace it with ipfs/ipfs-docs-v2. However, we still want to be able to view the git commit history and issues previously raised within this repository.

Project organization

Objectives for 2020 Q1

Here's a summary of this our objectives for the first three months of 2020:

  1. ✅ Launch the beta IPFS documentation site on the IPFS network.
  2. Improve documentation by creating new and/or enhancing existing content based on issues in this repo.
  3. Resolving or addressing any new GitHub issues created in this repo this quarter.
  4. Setting up and enabling a community of writers and content creators.

For more information regarding these objectives, check out the IPFS-wide Objectives and Key Results (OKRs) tracking document.

Suggestions

Do you have suggestions on future improvements to IPFS docs? You can vote on what you think the IPFS docs site should contain, along with features that you'd like to see over at canny.io/docs-features.

IPFS docs core members

Legacy code details

IMPORTANT! As noted above, this repo is home to the LEGACY docs site; if you want to make changes to IPFS docs, please visit github.com/ipfs/ipfs-docs-v2 and use the codebase there. However, if for some reason you need to run the legacy code locally, instructions are below.

One-time setup

  1. Install AEgir

    npm install -g aegir
`"

  2. Download dependencies and IPFS libraries (e.g., go-ipfs, js-ipfs) and generate their documentation:

    make install
`"

This installs dependencies and generates source files from other projects (e.g., API documentation, theme resources from the ipfs-css, etc). When dependencies or external packages (like go-ipfs) have new releases, you should regenerate files based on them by running make resources.

Build and run

  1. In the root directory, run make dev.
  2. Load localhost:1313 in your web browser.
  3. Edit and add things!

To create a production build, run make build instead. You'll find the final static site in the public directory.

License

All software code is copyright (c) Protocol Labs, Inc. under the MIT license. Other written documentation and content is copyright (c) Protocol Labs, Inc. under the Creative Commons Attribution-Share-Alike License. See LICENSE file for details.