Skip to content

Commit

Permalink
docs: Arlink draft complete
Browse files Browse the repository at this point in the history
  • Loading branch information
Bobinstein committed Dec 19, 2024
1 parent 7f779b9 commit 6f0fe53
Showing 1 changed file with 34 additions and 12 deletions.
46 changes: 34 additions & 12 deletions src/app/build/guides/arlink/page.mdx
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
import {HeroPattern} from "@/components/HeroPattern"

//TODO: add in the correct images.
{/* //TODO: add in the correct images. */}

export const metadata = {
title: 'Arlink Deploy',
description:
'Easily deploy a web app to Arweave with ArNS using Arlink.',
images: [
{
url: 'https://arweave.net/JluJoV__SITJWXvtzkoKvsMoRqQOWnvVX7G6kAj2RdU',
url: 'https://arweave.net/5NrPfFhNfS7p2Ci6giwwvPALL4lthCT2S1fPulsvnUM',
},
],
openGraph: {
title: 'Arlink Deploy',
images: [
{
url: 'https://arweave.net/JluJoV__SITJWXvtzkoKvsMoRqQOWnvVX7G6kAj2RdU',
url: 'https://arweave.net/5NrPfFhNfS7p2Ci6giwwvPALL4lthCT2S1fPulsvnUM',
},
],
},
Expand All @@ -25,7 +25,7 @@ export const metadata = {
site: '@ar_io_network',
images: [
{
url: 'https://arweave.net/JluJoV__SITJWXvtzkoKvsMoRqQOWnvVX7G6kAj2RdU',
url: 'https://arweave.net/5NrPfFhNfS7p2Ci6giwwvPALL4lthCT2S1fPulsvnUM',
},
],
},
Expand All @@ -51,25 +51,33 @@ Arlink also allows users to connect their project to an [ArNS](/learn/arns) name
After connecting your wallet to the Arlink web app using the button at the top right, you will be taken to your dashboard. This page will display any deployments associated with your wallet, and includes a "+ New Deployment" button
in order to start the process of deploying a new project.

//TODO: empty dashboard pic goes here
<img src="https://arweave.net/A9DUhLxvaWauTaZoQL6T0uSR6LANx49VD4d6fQ0FAjw" />

{/* //TODO: empty dashboard pic goes here */}

## New Deployment

After clicking on the new deployment button, you will be prompted to import a repository from either Github or Protocol.land.

//TODO: Import pic here
<img src="https://arweave.net/x6gDFJcJeY2sFyrEG5yR2EoTy7t9O0zL-lufdwgtCKo" />

{/* //TODO: Import pic here */}

### Authorize Github

If this is your first time importing from Github, you will be prompted to authorize Arlink to access your Github repositories. You can authorize all repositories, or limit authorization to any number of specific ones.

//TODO: authorize pic here
<img src="https://arweave.net/-tJqkaX1WRbmsxDv2GTlCsUtbkgwmzA88S2yKOtqZIM" />

{/* //TODO: authorize pic here */}

### Select Repository

Once authorization is approved, select which repository and branch you want to deploy.

//TODO: this pic here
<img src="https://arweave.net/fHxXbYicODMwN8lECwNAOHbkYZ08NS67rSGDFEecxBA" />

{/* //TODO: this pic here */}

### Define Build and Output Steps

Expand All @@ -85,23 +93,37 @@ Once you select what you want to deploy, you need to specify how the project nee

- ***Output Directory***: This is the path to the build folder being deployed. This will be different depending on the framework your project uses.

//TODO: another picture
<img src="https://arweave.net/oSnbN-Xw7gWTgSt8eNufVjzfHA52wKLPgFo4qdzHwxw" />

{/* //TODO: another picture */}

### Select ArNS

The last thing to do is select an ArNS name to deploy your project to. If you own your own name, you can connect to it here with the "Use existing ArNS" toggle. Otherwise, you can select an undername of the ArNS name `arlink` to deploy to.
Duplicate undernames cannot exist, so you can only select an undername that is not already being used.

<img src="https://arweave.net/zSda5gMCyw_IL0hZixxKfiaXFdwisfoQ2qb5X-EsJzk" />

//TODO: MOAR PICTURES!!

Once you select your ArNS name and click "Deploy", your project will be deployed.
### Logs

Once you select your ArNS name and click "Deploy", your project will be deployed. Logs from the build and deploy process will be displayed so you can monitor for errors.

<img src="https://arweave.net/1h5WjKdoPspOIop1_7R52sjnZsHWtRduAgZpzckCg2E" />

{/* //TODO: PICTOGRAPHICS!!!! */}

## Updates

To deploy a new build of your project, select it from the dashboard.

//TODO: This is mostly pictures at this point.
<img src="https://arweave.net/m-dgNKZKMNaXCWnz0OKiLUyifQrXCbZE3QGJGjiMdVw" />

{/* //TODO: This is mostly pictures at this point. */}

The project page gives you the option to update any settings or configurations, and has a "Deploy Latest" button which will redeploy your project.

//TODO: One last picture.
<img src="https://arweave.net/Gen_rEdn8ZGMMXY9_AdKIPnnL6w_rlz1B09EPugMje8" />

{/* //TODO: One last picture. */}

0 comments on commit 6f0fe53

Please sign in to comment.