Skip to content

Commit

Permalink
Merge pull request #637 from onflow/ianthpun/migrate-docs
Browse files Browse the repository at this point in the history
Add migration contract docs
  • Loading branch information
ianthpun committed Mar 7, 2024
2 parents ffbb162 + 9c7df4d commit 05ca7f5
Show file tree
Hide file tree
Showing 6 changed files with 132 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/tools/flow-cli/migrate/_category_.json
@@ -0,0 +1,4 @@
{
"label": "Migrate Projects to 1.0",
"position": 11
}
27 changes: 27 additions & 0 deletions docs/tools/flow-cli/migrate/migrate-get-staged-code.md
@@ -0,0 +1,27 @@
---
title: Get staged Cadence 1.0 Contract Code
description: How to get staged Cadence 1.0 contract code from the command line
sidebar_position: 5
---

Get the staged contract code from a contract thats been correctly staged.

```shell
flow migrate staged_code <contract_name>
```

## Example Usage

```
> flow migrate staged_code HelloWorld --network=testnet
Attempts to return the contract code of HelloWorld on the Testnet network.
```

## Arguments

### Contract Name

- Name: `contract_name`
- Valid Input: Existing contract name in `flow.json`.
27 changes: 27 additions & 0 deletions docs/tools/flow-cli/migrate/migrate-is-staged.md
@@ -0,0 +1,27 @@
---
title: Check if a contract is staged
description: How to check if a contract has been properly staged from the command line
sidebar_position: 4
---

Check to see if a contract has been staged from the Flow CLI

```shell
flow migrate is_staged <contract_name>
```

## Example Usage

```
> flow migrate is_staged HelloWorld --network=testnet
Attempts to confirm if the contract has been staged on the Testnet network.
```

## Arguments

### Contract Name

- Name: `contract_name`
- Valid Input: Existing contract name in `flow.json`.
20 changes: 20 additions & 0 deletions docs/tools/flow-cli/migrate/migrate-list-staged-contracts.md
@@ -0,0 +1,20 @@
---
title: List staged Cadence 1.0 Contracts
description: How to list staged Cadence 1.0 Contracts from the command line
sidebar_position: 3
---

Lists all Cadence 1.0 supported contracts that are staged from the Flow CLI.

```shell
flow migrate list-staged
```

## Example Usage

```
> flow migrate list-staged --network=testnet
Lists all staged contracts from the Testnet network.
```
27 changes: 27 additions & 0 deletions docs/tools/flow-cli/migrate/migrate-stage-contract.md
@@ -0,0 +1,27 @@
---
title: Staging a 1.0 Contract
description: How to stage a Cadence 1.0 supported Contract from the command line
sidebar_position: 1
---

Stage a Cadence 1.0 supported contract project using the Flow CLI.

```shell
flow migrate stage-contract <contract_name>
```

## Example Usage

```
> flow migrate stage-contract HelloWorld --network=testnet
Attempts to the stage the contract `HelloWorld` onto the Testnet network.
```

## Arguments

### Contract Name

- Name: `contract_name`
- Valid Input: Existing contract name in `flow.json`.
27 changes: 27 additions & 0 deletions docs/tools/flow-cli/migrate/migrate-unstage-contract.md
@@ -0,0 +1,27 @@
---
title: Unstaging a 1.0 Contract
description: How to unstage a Cadence 1.0 supported Contract from the command line
sidebar_position: 2
---

Unstage a Cadence 1.0 supported contract project using the Flow CLI.

```shell
flow migrate unstage-contract <contract_name>
```

## Example Usage

```
> flow migrate unstage-contract HelloWorld --network=testnet
Attempts to the unstage the contract `HelloWorld` from the Testnet network.
```

## Arguments

### Contract Name

- Name: `contract_name`
- Valid Input: Existing contract name in `flow.json`.

0 comments on commit 05ca7f5

Please sign in to comment.