Commit Graph

6 Commits

Author SHA1 Message Date
Ryan Christoffersen 3439e5d025
docs: fix migrations directory (#9746)
Co-authored-by: ryanchrypto <12519942+ryanchrypto@users.noreply.github.com>
2021-07-22 11:21:59 +02:00
Ryan Christoffersen 6098d7ed55
docs: add chain upgrade guide v0.43 (#9567)
## Description

<!-- Add a description of the changes that this PR introduces and the files that
are the most critical to review. -->

This pull request adds a chain upgrade guide and example for v0.43. This pull request also removes migration documentation specific to v0.42 and adds links to v0.42 documentation when referencing genesis migrations.

---

### Author Checklist

*All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.*

I have...

- [x] included the correct `docs:` prefix in the PR title
- [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting))
- [x] provided a link to the relevant issue or specification - n/a
- [x] followed the [documentation writing guidelines](https://github.com/cosmos/cosmos-sdk/blob/master/docs/DOC_WRITING_GUIDELINES.md)
- [x] reviewed "Files changed" and left comments if necessary
- [x] confirmed all CI checks have passed

### Reviewers Checklist

*All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.*

I have...

- [x] confirmed the correct `docs:` prefix in the PR title
- [x] confirmed all author checklist items have been addressed 
- [ ] confirmed that this PR only changes documentation
- [ ] reviewed content for consistency
- [ ] reviewed content for thoroughness
- [ ] reviewed content for spelling and grammar
- [ ] tested instructions (if applicable)
2021-07-19 15:35:56 +00:00
likhita-809 0e64fa77d1
docs: Add docs for setting store loader (#9526)
## Description

Closes: #9503 

<!-- Add a description of the changes that this PR introduces and the files that
are the most critical to review. -->

Add documentation for setting StoreLoader as part of in-place store migration.

---

### Author Checklist

*All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.*

I have...

- [x] included the correct `docs:` prefix in the PR title
- [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting))
- [x] provided a link to the relevant issue or specification
- [ ] followed the [documentation writing guidelines](https://github.com/cosmos/cosmos-sdk/blob/master/docs/DOC_WRITING_GUIDELINES.md)
- [ ] reviewed "Files changed" and left comments if necessary
- [ ] confirmed all CI checks have passed

### Reviewers Checklist

*All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.*

I have...

- [x] confirmed the correct `docs:` prefix in the PR title
- [ ] confirmed all author checklist items have been addressed 
- [x] confirmed that this PR only changes documentation
- [x] reviewed content for consistency
- [x] reviewed content for thoroughness
- [x] reviewed content for spelling and grammar
- [ ] tested instructions (if applicable)
2021-06-17 15:04:33 +00:00
Ryan Christoffersen cb66c99eab
chore: add markdownlint to lint commands (#9353)
* add markdownlint config

* update make lint commands

* update markdownlint config

* run make lint-fix

* fix empty link

* resuse docker container

* run lint-fix

* do not echo commands

Co-authored-by: ryanchrypto <12519942+ryanchrypto@users.noreply.github.com>
2021-05-27 15:31:04 +00:00
Ryan Christoffersen b635ae2090
Update docs for building modules (#9272)
* update example structure

* update example structure

* update module errors path

* update paths and fix typos

* update paths and fix typos

* update example structure

* address review comments
2021-05-07 18:13:06 -04:00
technicallyty 849fab120b
documentation for in-place migrations with x/upgrade module (#8967)
* upgrade draft docs

* upgrade draft docs2

* change to generic id

* Update docs/building-modules/upgrade.md

Co-authored-by: Amaury <1293565+amaurym@users.noreply.github.com>

* Update docs/building-modules/README.md

Co-authored-by: Amaury <1293565+amaurym@users.noreply.github.com>

* Update docs/building-modules/upgrade.md

Co-authored-by: Amaury <1293565+amaurym@users.noreply.github.com>

* Update docs/building-modules/upgrade.md

Co-authored-by: Amaury <1293565+amaurym@users.noreply.github.com>

* Update docs/building-modules/upgrade.md

Co-authored-by: Amaury <1293565+amaurym@users.noreply.github.com>

* Update docs/building-modules/upgrade.md

Co-authored-by: Amaury <1293565+amaurym@users.noreply.github.com>

* Update docs/building-modules/upgrade.md

Co-authored-by: Amaury <1293565+amaurym@users.noreply.github.com>

* Update docs/building-modules/upgrade.md

Co-authored-by: Amaury <1293565+amaurym@users.noreply.github.com>

* Update docs/core/README.md

Co-authored-by: Amaury <1293565+amaurym@users.noreply.github.com>

* Update docs/core/upgrade.md

Co-authored-by: Amaury <1293565+amaurym@users.noreply.github.com>

* Update docs/core/upgrade.md

Co-authored-by: Amaury <1293565+amaurym@users.noreply.github.com>

* added lines for version map and consensus versions

* fix headers, add synopsis tag

* docs for new modules

* fix

* remove line

* Update docs/core/upgrade.md

Co-authored-by: Amaury <1293565+amaurym@users.noreply.github.com>

* Update docs/building-modules/upgrade.md

Co-authored-by: Amaury <1293565+amaurym@users.noreply.github.com>

* SetUpgradeHandler example snippet

* -general clean up of docs
-include PR #9007 information

* Update docs/core/upgrade.md

Co-authored-by: Amaury <1293565+amaurym@users.noreply.github.com>

* Update docs/core/upgrade.md

Co-authored-by: Amaury <1293565+amaurym@users.noreply.github.com>

* Update docs/core/upgrade.md

Co-authored-by: Amaury <1293565+amaurym@users.noreply.github.com>

* Update docs/core/upgrade.md

Co-authored-by: Amaury <1293565+amaurym@users.noreply.github.com>

* Update docs/core/upgrade.md

Co-authored-by: Amaury <1293565+amaurym@users.noreply.github.com>

* Update docs/core/upgrade.md

Co-authored-by: Amaury <1293565+amaurym@users.noreply.github.com>

* Update docs/core/upgrade.md

Co-authored-by: Amaury <1293565+amaurym@users.noreply.github.com>

* Update docs/core/upgrade.md

Co-authored-by: Amaury <1293565+amaurym@users.noreply.github.com>

* Update docs/core/upgrade.md

Co-authored-by: Amaury <1293565+amaurym@users.noreply.github.com>

* Update docs/core/upgrade.md

Co-authored-by: Amaury <1293565+amaurym@users.noreply.github.com>

* Update docs/core/upgrade.md

Co-authored-by: Amaury <1293565+amaurym@users.noreply.github.com>

* Update docs/core/upgrade.md

Co-authored-by: Amaury <1293565+amaurym@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>

* fix self-reference

* clearer definitions for overwriting genesis functions

* add sync section

* forgot to save this

* update description of initgenesis modules

* specify upgrade method

* Update docs/core/upgrade.md

Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>

Co-authored-by: technicallyty <48813565+tytech3@users.noreply.github.com>
Co-authored-by: Amaury <1293565+amaurym@users.noreply.github.com>
Co-authored-by: Barrie Byron <barrie.byron@tendermint.com>
Co-authored-by: Alessio Treglia <alessio@tendermint.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
2021-04-14 08:49:17 +00:00