Skip to content

Commit

Permalink
docs: add migration steps for Ignite CLI v0.27.1 (#3558)
Browse files Browse the repository at this point in the history
* docs: add initial migration steps for v0.27.1

There are more `app.go` changes to be added to the migration guide and
after that the document must be copied to nightly docs.

* docs: add `app.go` changes

* chore: remove init function from app changes

* chore: add missing remove line

* docs: add missing migration steps

* docs: add app changes for IBC migration

* docs: add missing migration steps

* docs: add missing migration steps

* chore: add link to parameters migration

Using the new Ignite CLI version won't work with an existing app state
unless the parameters are migrated. Without the migration the app can
oly be run using the `--reset-once` flag.

* chore: copy migration docs to nightly documentation

* docs: correct issues in documentation

* fix: correct link issues

The issues have no relation to the migration PR but fixes are required
to pass CI checks.
  • Loading branch information
jeronimoalbi authored Jun 29, 2023
1 parent 252f7d4 commit 75d3338
Show file tree
Hide file tree
Showing 19 changed files with 2,467 additions and 52 deletions.
3 changes: 3 additions & 0 deletions .github/workflows/md-link-checker-config.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
{
"ignorePatterns": [
{
"pattern": "^https://twitter.com"
},
{
"pattern": "^https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request"
},
Expand Down
2 changes: 1 addition & 1 deletion .gitpod/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ ignite chain serve
curl https://get.ignite.com/cli | bash
```

The latest `ignite` binary is downloaded from the project repo and installed in `/usr/local/bin`. Learn more about [installing Ignite CLI](https://docs.ignite.com/guide/install).
The latest `ignite` binary is downloaded from the project repo and installed in `/usr/local/bin`. Learn more about [installing Ignite CLI](https://docs.ignite.com/welcome/install).

## Stay in touch

Expand Down
7 changes: 3 additions & 4 deletions contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,11 +68,10 @@ used as the commit message.

When you open a PR for the Ignite CLI codebase, you must also update the relevant documentation. For changes to:

* [Developer Guide](https://docs.ignite.com/guide) tutorials, update content in the `/docs/guide` folder.
* [Knowledge Base](https://docs.ignite.com/kb), update content in the `/docs/kb` folder.
* [Ignite CLI reference](https://docs.ignite.com/cli), navigate to the `./ignite/cmd` package and update the
* [Developer Guide](https://docs.ignite.com/guide) tutorials, update content in the `/docs/docs/02-guide` folder.
* [Ignite CLI reference](https://docs.ignite.com/references/cli), navigate to the `./ignite/cmd` package and update the
documentation of the related command from its `cobra.Command` struct. The CLI docs are automatically generated, so do
not make changes to `docs/cli/index.md`.
not make changes to `docs/docs/08-references/01-cli.md`.

### Ask for help

Expand Down
19 changes: 9 additions & 10 deletions docs/docs/02-guide/02-getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ following command:
ignite scaffold chain example
```

The [`ignite scaffold chain`](../references/cli#ignite-scaffold-chain) command will create a
new blockchain in a new directory `example`.
The `ignite scaffold chain` command will create a new blockchain in a new
directory `example`.

The new blockchain is built using the Cosmos SDK framework and imports several
standard modules to provide a range of functionality. These modules include
Expand Down Expand Up @@ -132,14 +132,13 @@ To start a blockchain node in development, you can run the following command:
ignite chain serve
```

The [`ignite chain serve`](../references/cli#ignite-scaffold-chain) command is used to start
a blockchain node in development mode. It first compiles and installs the binary
using the `ignite chain build` command, then initializes the blockchain's data
directory for a single validator using the `ignite chain init` command. After
that, it starts the node locally and enables automatic code reloading so that
changes to the code can be reflected in the running blockchain without having to
restart the node. This allows for faster development and testing of the
blockchain.
The `ignite chain serve` command is used to start a blockchain node in
development mode. It first compiles and installs the binary using the
`ignite chain build` command, then initializes the blockchain's data directory
for a single validator using the `ignite chain init` command. After that, it
starts the node locally and enables automatic code reloading so that changes to
the code can be reflected in the running blockchain without having to restart
the node. This allows for faster development and testing of the blockchain.

Congratulations! 🥳 You have successfully created a brand-new Cosmos blockchain
using the Ignite CLI. This blockchain uses the delegated proof of stake (DPoS)
Expand Down
3 changes: 1 addition & 2 deletions docs/docs/03-clients/02-typescript.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@ Ignite offers powerful functionality for generating client-side code for your
blockchain. Think of this as a one-click client SDK generation tailored
specifically for your blockchain.

See [`ignite generate ts-client --help`](../references/cli#ignite-generate-ts-client) learn
more on how to use TypeScript code generation.
See `ignite generate ts-client --help` learn more on how to use TypeScript code generation.

## Starting a node

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/06-migration/v0.26.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ specific changes that will need to be followed for Ignite scaffolded chains.

### Removing `cosmosibckeeper`

Ignite CLI `v0.26.0` has deprecated [pkg/cosmosibckeeper](https://github.com/ignite/cli/tree/main/ignite/pkg/cosmosibckeeper).
Ignite CLI `v0.26.0` has deprecated [pkg/cosmosibckeeper](https://github.com/ignite/cli/tree/v0.26.0/ignite/pkg/cosmosibckeeper).
This package contained interfaces for ibc-related keepers. Newly scaffolded chains now include the interface files in their
`./x/{moduleName}/types` directory in a new `expected_ibc_keeper.go` file. To migrate, create the following file for
each module:
Expand Down
Loading

0 comments on commit 75d3338

Please sign in to comment.