add website deployment guide #1999
Conversation
2color
force-pushed
the
add-website-guide
branch
from
24cb06b to
d45ee53
Compare
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
|
||
| **TODO: This whole section should probably move to a separate guide that can be linked to from here** | ||
|
|
||
| By default, each deployment will be addressed with a CID. Since CIDs are long and hard to remember, they're not very user friendly, for example, `https://bafybeifhgtpm6kmbyqszbardceszvkv5rsi3dodtuufpcfskzggekcfl2y.ipfs.inbrowser.link/`. |
There was a problem hiding this comment.
[LanguageTool] reported by reviewdog 🐶
This word is normally spelled with a hyphen. (EN_COMPOUNDS_USER_FRIENDLY)
Suggestions: user-friendly
Rule: https://community.languagetool.org/rule/show/EN_COMPOUNDS_USER_FRIENDLY?lang=en-US
Category: MISC
| - Storacha Gateway: `https://<CID>.ipfs.storacha.network` | ||
| - IPFS.io Gateway: `https://ipfs.io/ipfs/<CID>` | ||
| - Cloudflare Gateway: `https://cloudflare-ipfs.com/ipfs/<CID>` |
There was a problem hiding this comment.
cloudflare is no more, and since we talk abotu websites here, fine to default to subdomains (need them for relative pathing anyway):
| - Storacha Gateway: `https://<CID>.ipfs.storacha.network` | |
| - IPFS.io Gateway: `https://ipfs.io/ipfs/<CID>` | |
| - Cloudflare Gateway: `https://cloudflare-ipfs.com/ipfs/<CID>` | |
| - [Storacha Gateway](https://docs.storacha.network/concepts/ipfs-gateways/): `https://<CID>.ipfs.w3s.link` | |
| - [Public Good Gateway](../concepts/public-utilities.md#public-ipfs-gateways): `https://<CID>.ipfs.dweb.link` |
Co-authored-by: Marcin Rataj <[email protected]>
|
|
||
| ## Step 2: Configure Your Workflow | ||
|
|
||
| Create a new file `.github/workflows/deploy.yml` in your repository: |
There was a problem hiding this comment.
[LanguageTool] reported by reviewdog 🐶
The official name of this software platform is spelled with a capital “H”. (GITHUB[1])
Suggestions: GitHub
URL: https://en.wikipedia.org/wiki/GitHub
Rule: https://community.languagetool.org/rule/show/GITHUB?lang=en-US&subId=1
Category: CASING
| run: npm run build | ||
|
|
||
| - name: Deploy to IPFS | ||
| uses: ipfs/ipfs-deploy-action@v1 |
There was a problem hiding this comment.
[LanguageTool] reported by reviewdog 🐶
This abbreviation for “identification” is spelled all-uppercase. (ID_CASING[2])
Suggestions: ID
Rule: https://community.languagetool.org/rule/show/ID_CASING?lang=en-US&subId=2
Category: CASING
| path-to-deploy: dist # Change this to your build output directory | ||
| storacha-key: ${{ secrets.STORACHA_KEY }} | ||
| storacha-proof: ${{ secrets.STORACHA_PROOF }} | ||
| github-token: ${{ github.token }} |
There was a problem hiding this comment.
[LanguageTool] reported by reviewdog 🐶
The official name of this software platform is spelled with a capital “H”. (GITHUB[1])
Suggestions: GitHub
URL: https://en.wikipedia.org/wiki/GitHub
Rule: https://community.languagetool.org/rule/show/GITHUB?lang=en-US&subId=1
Category: CASING
| path-to-deploy: dist # Change this to your build output directory | ||
| storacha-key: ${{ secrets.STORACHA_KEY }} | ||
| storacha-proof: ${{ secrets.STORACHA_PROOF }} | ||
| github-token: ${{ github.token }} |
There was a problem hiding this comment.
[LanguageTool] reported by reviewdog 🐶
If a new sentence starts here, add a space and start with an uppercase letter. (LC_AFTER_PERIOD[1])
Suggestions: Token, token
Rule: https://community.languagetool.org/rule/show/LC_AFTER_PERIOD?lang=en-US&subId=1
Category: CASING
🚀 Build Preview on IPFS ready
|
What's in this PR
Add deployment to IPFS guide
Why
Helps with the most common use-case of web publishing.
TODO