This repository is home to in-development work on a VuePress/Forestry-based replacement for the existing IPFS blog. Target go-live is in late Q1 2021. Contact @jessicaschilling with any questions.

This work is part of a larger product-market fit realignment/enhancement effort on the IPFS website as a whole. View tracking board.

⚠️⚠️⚠️
If you want to publish a blog post, don't do it here yet — use the existing blog instead!
⚠️⚠️⚠️

Workflow for post authors/editors

This site uses the staging branch as a work-in-progress scratchpad for blog content. Once approved for go-live, staging is merged into main; the production site is automatically deployed from the latest main using Fleek.

Post authors and editors are strongly encouraged to use this site's Forestry integration for drafting and editing, including perks like WYSIWYG editing and image upload/crop tools. If you're an IPFS core team member and don't have Forestry access, contact @jessicaschilling to arrange access and a quick orientation session. (If you prefer writing in Markdown, don't fear: Forestry also has a raw Markdown view.)

Forestry tips

Foo

To deploy to the live site

Forestry writes directly to staging, with previews available at https://ipfs-blog-staging.on.fleek.co/. Once a staged post is ready to go live, please PR staging to main using this handy shortcut. Note that if multiple posts are in-flight in staging and only one is approved to go live, your PR may need some massaging.

Just want to add a new "link card"?

Feel free to use Forestry to add details for "link cards" like videos, release notes or news items, and submit a PR for review/merge. However, if you're in a hurry, simply fill in the public submission form and a site maintainer will take care of the rest.

Workflow for site developers

Important! All site development forks/PRs (as opposed to blog posts) should be based on and merged into main, not staging.

Build and run locally

This site is built in Vuepress, and uses Vue/JavaScript for functional code and Markdown for post content.

To build a local copy, run the following:

Clone this repository:

git clone https://github.com/ipfs/ipfs-blog.git

Move into the ipfs-blog folder and install the NPM dependencies:
```
cd ipfs-docs
npm install
```
Boot up the application in dev mode:
```
npm start
```
Open localhost:8080 in your browser.
Close the local server with CTRL + c.
To restart the local server, run npm start from within the ipfs-blog folder.

PR and preview

Once you're happy with your local changes, please make a PR against the main branch. Including detailed notes on your PR helps smooth the approval and deployment process, so make sure to thoroughly document your changes, including screenshots to depict any changes in UI.

PRs against main will automatically generate Fleek previews for ease of review. A successful run of a Fleek preview build generates a live preview viewable by clicking Details in the fleek/build check at the bottom of your PR page:

A reviewer will be by shortly to have a look!

Maintainers

This site is under active maintenance by members of the core IPFS team.

README.md

IPFS Blog (v2 Beta)