adam/ipfs-blog
1
0
Fork 0
mirror of https://github.com/ipfs/ipfs-blog.git synced 2026-08-07 01:12:47 +02:00
Code Issues Packages Projects Releases Wiki Activity

Clarify dev instructions

Browse Source
This commit is contained in:
Jessica Schilling
2021-03-04 14:50:04 -07:00
committed by GitHub
parent 7f06777468
commit 01f81bcfc9
1 changed files with 9 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+9 -7
View File
@@ -3,17 +3,17 @@
[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](https://protocol.ai)
[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)
This repository is home to in-development work on a VuePress/Forestry-based IPFS blog to replace [the existing IPFS blog](https://blog.ipfs.io). Target go-live is in late Q1 2021. Contact @jessicaschilling with any questions.
This repository is home to in-development work on a VuePress/Forestry-based replacement for [the existing IPFS blog](https://blog.ipfs.io). 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.](https://github.com/orgs/ipfs/projects/11)
⚠️⚠️⚠️ **If you want to publish a blog post, don't do it here yet** — use [the existing blog](https://github.com/ipfs/blog) instead!
⚠️⚠️⚠️<br/>**If you want to publish a blog post, don't do it here yet** — use [the existing blog](https://github.com/ipfs/blog) instead!<br/>⚠️⚠️⚠️
## 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](https://fleek.co/).
Post authors and editors are strongly encouraged to use this site's [Forestry](https://forestry.io) 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.)
Post authors and editors are strongly encouraged to [use this site's Forestry integration](https://forestry.io) 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
@@ -29,11 +29,11 @@ Feel free to use Forestry to add details for "link cards" like videos, release n
## Workflow for site developers
**Important!** All site development forks/PRs (as opposed to blog posts) should be based on and merged into `main`.
This site is built in [Vuepress](https://vuepress.vuejs.org/guide/), and uses Vue/JavaScript for functional code and Markdown for post content.
**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](https://vuepress.vuejs.org/guide/), and uses Vue/JavaScript for functional code and Markdown for post content.
To build a local copy, run the following:
1. Clone this repository:
@@ -60,11 +60,13 @@ To build a local copy, run the following:
1. 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.
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:
![image](https://user-images.githubusercontent.com/1507828/110034382-9dbb5b80-7cf7-11eb-89a4-7772970677d3.png)
A reviewer will be by shortly to have a look!
## Maintainers
This site is under active maintenance by members of the core [IPFS team](https://ipfs.io/team/).