Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add migration contract docs #637

Merged
merged 8 commits into from Mar 7, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
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
}
28 changes: 28 additions & 0 deletions docs/tools/flow-cli/migrate/migrate-get-staged-code.md
@@ -0,0 +1,28 @@
---
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=previewnet
ianthpun marked this conversation as resolved.
Show resolved Hide resolved

Attempts to return the contract code of HelloWorld on the Previewnet network.
ianthpun marked this conversation as resolved.
Show resolved Hide resolved

```

## Arguments

### Contract Name

- Name: `contract_name`
- Valid Input: Existing contract name in `flow.json`.
28 changes: 28 additions & 0 deletions docs/tools/flow-cli/migrate/migrate-is-staged.md
@@ -0,0 +1,28 @@
---
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=previewnet
ianthpun marked this conversation as resolved.
Show resolved Hide resolved

Attempts to confirm if the contract has been staged on the Previewnet network.

```

## Arguments

### Contract Name

- Name: `contract_name`
- Valid Input: Existing contract name in `flow.json`.
21 changes: 21 additions & 0 deletions docs/tools/flow-cli/migrate/migrate-list-staged-contracts.md
@@ -0,0 +1,21 @@
---
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=previewnet
ianthpun marked this conversation as resolved.
Show resolved Hide resolved

Lists all staged contracts from the Previewnet network.

```
28 changes: 28 additions & 0 deletions docs/tools/flow-cli/migrate/migrate-stage-contract.md
@@ -0,0 +1,28 @@
---
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=previewnet
ianthpun marked this conversation as resolved.
Show resolved Hide resolved

Attempts to the stage the contract `HelloWorld` onto the Previewnet network.
ianthpun marked this conversation as resolved.
Show resolved Hide resolved

```

## Arguments

### Contract Name

- Name: `contract_name`
- Valid Input: Existing contract name in `flow.json`.
28 changes: 28 additions & 0 deletions docs/tools/flow-cli/migrate/migrate-unstage-contract.md
@@ -0,0 +1,28 @@
---
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=previewnet
ianthpun marked this conversation as resolved.
Show resolved Hide resolved

Attempts to the unstage the contract `HelloWorld` from the Previewnet network.
ianthpun marked this conversation as resolved.
Show resolved Hide resolved

```

## Arguments

### Contract Name

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