diff --git a/docs/README.md b/docs/README.md index c655a2aa0..e663ce548 100644 --- a/docs/README.md +++ b/docs/README.md @@ -5,7 +5,7 @@ description: The home page for developer documentation for IPFS, the InterPlanet # Welcome to the IPFS Docs -IPFS is a set of building blocks for a better web. Open protocols to make your data smarter: content-addressed, verifiable, and unstoppable. +The InterPlanetary File System (IPFS) is a set of building blocks for a better web. Open protocols to make your data smarter: content-addressed, verifiable, and unstoppable. On a more technical level, IPFS is a set of open protocols for addressing, routing, and transferring data on the web, built on the ideas of [content addressing](concepts/glossary.md#content-addressing) and peer-to-peer networking. @@ -28,6 +28,9 @@ Provide data to the IPFS network with IPFS Desktop or a pinning service: - [Install IPFS Desktop which bundles an IPFS node (Kubo) and a UI to manage files, peers, and explore content on IPFS](./install/ipfs-desktop.md). - [Publish content to the IPFS network with IPFS Desktop](./how-to/desktop-app.md). + +### Deploy static sites to the IPFS network + - [Deploy static sites to the IPFS network with a GitHub Action](./how-to/websites-on-ipfs/deploy-github-action.md). ### Build diff --git a/docs/how-to/websites-on-ipfs/deploy-github-action.md b/docs/how-to/websites-on-ipfs/deploy-github-action.md index 3d7663677..2400d3d03 100644 --- a/docs/how-to/websites-on-ipfs/deploy-github-action.md +++ b/docs/how-to/websites-on-ipfs/deploy-github-action.md @@ -7,7 +7,7 @@ current-ipfs-cluster-version: v1.1.2 # Deploy Static Apps to IPFS with GitHub Actions -This guide will walk you through the process of configuring a [GitHub Actions](https://docs.github.com/en/actions) workflow to deploy a repository containing a static site or app to IPFS using the [IPFS Deploy Action](https://github.com/ipfs/ipfs-deploy-action). +This guide will walk you through the process of configuring a [GitHub Actions](https://docs.github.com/en/actions) workflow to deploy a repository containing a static site or app to IPFS using the [IPFS Deploy Action](https://github.com/ipshipyard/ipfs-deploy-action). By the end of this guide, your web app (or just a static website) will be deployed to IPFS automatically when you push to your repository. It will also deploy pull request previews for each commit, and provide some other developer experience features, like commit status updates with the CID of the build, and a comment on pull requests with the IPFS CID and preview links. @@ -21,7 +21,7 @@ To see what this looks like in a real-world example, check out the [IPNS Inspect ## What is the IPFS Deploy Action? -The [IPFS Deploy Action](https://github.com/ipfs/ipfs-deploy-action) is a [composite action](https://docs.github.com/en/actions/creating-actions/creating-a-composite-action), that can be called as a step in a [GitHub Actions workflow](https://docs.github.com/en/actions/writing-workflows), and combines the following features: +The [IPFS Deploy Action](https://github.com/ipshipyard/ipfs-deploy-action) is a [composite action](https://docs.github.com/en/actions/creating-actions/creating-a-composite-action), that can be called as a step in a [GitHub Actions workflow](https://docs.github.com/en/actions/writing-workflows), and combines the following features: - 📦 Merkleizes your static site into a [CAR](../../concepts/glossary.md#car) file - 🚀 Uploads CAR file to either [Storacha](https://storacha.network/), [IPFS Cluster](https://ipfscluster.io/), or [Kubo](https://github.com/ipfs/kubo#readme) @@ -300,5 +300,5 @@ This URL uses subdomain resolution (where the CID has its own subdomain), which If you encounter any issues: 1. Check the GitHub Actions run logs for detailed error messages -2. Review the [action's README](https://github.com/ipfs/ipfs-deploy-action) for updates -3. Open an issue in the [action's repository](https://github.com/ipfs/ipfs-deploy-action/issues/new) with detailed information about your setup and the problem you're experiencing +2. Review the [action's README](https://github.com/ipshipyard/ipfs-deploy-action) for updates +3. Open an issue in the [action's repository](https://github.com/ipshipyard/ipfs-deploy-action/issues/new) with detailed information about your setup and the problem you're experiencing diff --git a/docs/install/README.md b/docs/install/README.md index 0ac713304..989defe93 100644 --- a/docs/install/README.md +++ b/docs/install/README.md @@ -19,9 +19,9 @@ Anyone can use IPFS to store files in a _decentralized_ way. The easiest way to If your browser doesn't support IPFS yet, you can install an IPFS companion extension that will let you view decentralized web content! [Learn more →](./ipfs-companion.md) -### Publish files with a pinning service +### Deploy static sites to the IPFS network with a GitHub Action -Do you want to quickly and easily publish content with IPFS without complex tools? See the [Publish with IPFS quickstart](../quickstart/publish.md), where you'll learn how to use third-party pinning services to pin and provide files to the IPFS network. +Do you want to quickly and easily automate the deployment of static websites to the IPFS network? See the [Deploy static sites to the IPFS network with GitHub Actions](../how-to/websites-on-ipfs/deploy-github-action.md), where you'll learn how to use [GitHub Actions](https://github.com/ipshipyard/ipfs-deploy-action) to automatically deploy static websites to the IPFS network. ## Infrastructure Tools @@ -43,7 +43,7 @@ If you need to run your own [delegated routing](../concepts/glossary.md#delegate ## Software Development -### Helia SDK for JS +### Helia for TypeScript/JavaScript [Helia](https://github.com/ipfs/helia) is a new implementation of IPFS in JavaScript that is designed to be more modular and lightweight than the [deprecated js-ipfs project](https://github.com/ipfs/js-ipfs).