Skip to content

Commit

Permalink
docs: fix cosmovisor quickstart (backport cosmos#9730) (cosmos#9789)
Browse files Browse the repository at this point in the history
* docs: fix cosmovisor quickstart (cosmos#9730)

## Description

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

Automatically create a copy of [Cosmovisor Quickstart](https://docs.cosmos.network/v0.43/run-node/cosmovisor.html) from [Cosmovisor README](https://github.com/cosmos/cosmos-sdk/blob/master/cosmovisor/README.md) and minor fixes to Cosmovisor README.

---

### 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
- [x] 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...

- [ ] confirmed the correct `docs:` prefix in the PR title
- [ ] 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)

(cherry picked from commit bf049d3)

# Conflicts:
#	docs/run-node/cosmovisor.md

* fix conflicts

Co-authored-by: Ryan Christoffersen <[email protected]>
Co-authored-by: ryanchrypto <[email protected]>
  • Loading branch information
3 people authored and JeancarloBarrios committed Sep 28, 2024
1 parent dfe73b7 commit dc3bdcb
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 43 deletions.
7 changes: 6 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,12 @@ private

# Build
vendor
/build
build
docs/_build
docs/tutorial
docs/node_modules
docs/modules
docs/run-node/cosmovisor.md
dist
tools-stamp
buf-stamp
Expand Down
15 changes: 2 additions & 13 deletions docs/post.sh
Original file line number Diff line number Diff line change
@@ -1,15 +1,4 @@
#!/usr/bin/env bash

find build/modules ! -name '_category_.json' -type f -exec rm -rf {} +
rm -rf build/tooling/01-cosmovisor.md
rm -rf build/tooling/02-confix.md
rm -rf build/tooling/03-hubl.md
rm -rf build/packages/01-depinject.md
rm -rf build/packages/02-collections.md
rm -rf build/packages/03-orm.md
rm -rf learn/advaced-concepts/17-autocli.md
rm -rf build/architecture
rm -rf build/spec
rm -rf build/rfc
rm -rf learn/advanced/17-autocli.md
rm -rf build/migrations/02-upgrading.md
rm -rf modules
rm -rf run-node/cosmovisor.md
31 changes: 2 additions & 29 deletions docs/pre.sh
Original file line number Diff line number Diff line change
Expand Up @@ -17,33 +17,6 @@ for D in ../x/*; do
fi
done

## Vesting is a submodule of auth, but we still want to display it in docs
## TODO to be removed in https://github.com/cosmos/cosmos-sdk/issues/9958
cp -r ../x/auth/vesting/README.md ./build/modules/auth/1-vesting.md
cp -r ../x/auth/tx/README.md ./build/modules/auth/2-tx.md
cat ../x/README.md | sed 's/\.\/x/\/modules/g' | sed 's/spec\/README.md//g' | sed 's/\.\.\/docs\/building-modules\/README\.md/\/building-modules\/intro\.html/g' > ./modules/README.md

## Add modules page list
cat ../x/README.md | sed 's/\.\.\/\/build\/building-modules\/README\.md/\/building-modules\/intro\.html/g' > ./build/modules/README.md

## Add tooling documentation
cp ../tools/cosmovisor/README.md ./build/tooling/01-cosmovisor.md
cp ../tools/confix/README.md ./build/tooling/02-confix.md
cp ../tools/hubl/README.md ./build/tooling/03-hubl.md

## Add package documentation
cp ../client/v2/README.md ./learn/advanced/17-autocli.md
cp ../depinject/README.md ./build/packages/01-depinject.md
cp ../collections/README.md ./build/packages/02-collections.md
cp ../orm/README.md ./build/packages/03-orm.md

## Add architecture documentation
cp -r ./architecture ./build

## Add spec documentation
cp -r ./spec ./build

## Add rfc documentation
cp -r ./rfc ./build

## Add SDK migration documentation
cp -r ../UPGRADING.md ./build/migrations/02-upgrading.md
cp ../cosmovisor/README.md ./run-node/cosmovisor.md

0 comments on commit dc3bdcb

Please sign in to comment.