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

refactor: docs path updates (backport #17459) #17624

Merged
merged 5 commits into from
Sep 5, 2023

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Sep 5, 2023

This is an automatic backport of pull request #17459 done by Mergify.
Cherry-pick of f198ea9 has failed:

On branch mergify/bp/release/v0.50.x/pr-17459
Your branch is up to date with 'origin/release/v0.50.x'.

You are currently cherry-picking commit f198ea944.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	modified:   docs/.gitignore
	modified:   docs/architecture/adr-033-protobuf-inter-module-comm.md
	modified:   docs/architecture/adr-063-core-module-api.md
	renamed:    docs/docs/README.md -> docs/docs/Introduction.md
	renamed:    docs/docs/building-apps/00-app-go.md -> docs/docs/build/building-apps/00-app-go.md
	renamed:    docs/docs/building-apps/01-app-go-v2.md -> docs/docs/build/building-apps/01-app-go-v2.md
	renamed:    docs/docs/building-apps/02-app-mempool.md -> docs/docs/build/building-apps/02-app-mempool.md
	renamed:    docs/docs/building-apps/03-app-upgrade.md -> docs/docs/build/building-apps/03-app-upgrade.md
	renamed:    docs/docs/building-apps/04-vote-extensions.md -> docs/docs/build/building-apps/04-vote-extensions.md
	renamed:    docs/docs/building-apps/_category_.json -> docs/docs/build/building-apps/_category_.json
	renamed:    docs/docs/building-modules/01-intro.md -> docs/docs/build/building-modules/01-intro.md
	renamed:    docs/docs/building-modules/02-messages-and-queries.md -> docs/docs/build/building-modules/02-messages-and-queries.md
	renamed:    docs/docs/building-modules/03-msg-services.md -> docs/docs/build/building-modules/03-msg-services.md
	renamed:    docs/docs/building-modules/04-query-services.md -> docs/docs/build/building-modules/04-query-services.md
	renamed:    docs/docs/building-modules/05-beginblock-endblock.md -> docs/docs/build/building-modules/05-beginblock-endblock.md
	renamed:    docs/docs/building-modules/07-invariants.md -> docs/docs/build/building-modules/07-invariants.md
	renamed:    docs/docs/building-modules/08-genesis.md -> docs/docs/build/building-modules/08-genesis.md
	renamed:    docs/docs/building-modules/09-module-interfaces.md -> docs/docs/build/building-modules/09-module-interfaces.md
	renamed:    docs/docs/building-modules/11-structure.md -> docs/docs/build/building-modules/11-structure.md
	renamed:    docs/docs/building-modules/12-errors.md -> docs/docs/build/building-modules/12-errors.md
	renamed:    docs/docs/building-modules/13-upgrade.md -> docs/docs/build/building-modules/13-upgrade.md
	renamed:    docs/docs/building-modules/14-simulator.md -> docs/docs/build/building-modules/14-simulator.md
	renamed:    docs/docs/building-modules/15-depinject.md -> docs/docs/build/building-modules/15-depinject.md
	renamed:    docs/docs/building-modules/16-testing.md -> docs/docs/build/building-modules/16-testing.md
	renamed:    docs/docs/building-modules/_category_.json -> docs/docs/build/building-modules/_category_.json
	renamed:    docs/docs/migrations/01-intro.md -> docs/docs/build/migrations/01-intro.md
	renamed:    docs/docs/migrations/_category_.json -> docs/docs/build/migrations/_category_.json
	renamed:    docs/docs/modules/_category_.json -> docs/docs/build/modules/_category_.json
	renamed:    docs/docs/packages/_category_.json -> docs/docs/build/packages/_category_.json
	renamed:    docs/docs/tooling/_category_.json -> docs/docs/build/tooling/_category_.json
	deleted:    docs/docs/building-modules/01-module-manager.md
	deleted:    docs/docs/building-modules/06-keeper.md
	deleted:    docs/docs/core/00-baseapp.md
	renamed:    docs/docs/core/01-transactions.md -> docs/docs/develop/advanced/01-transactions.md
	renamed:    docs/docs/core/02-context.md -> docs/docs/develop/advanced/02-context.md
	renamed:    docs/docs/core/03-node.md -> docs/docs/develop/advanced/03-node.md
	renamed:    docs/docs/core/04-store.md -> docs/docs/develop/advanced/04-store.md
	renamed:    docs/docs/core/05-encoding.md -> docs/docs/develop/advanced/05-encoding.md
	renamed:    docs/docs/core/06-grpc_rest.md -> docs/docs/develop/advanced/06-grpc_rest.md
	renamed:    docs/docs/core/07-cli.md -> docs/docs/develop/advanced/07-cli.md
	renamed:    docs/docs/core/08-events.md -> docs/docs/develop/advanced/08-events.md
	renamed:    docs/docs/core/09-telemetry.md -> docs/docs/develop/advanced/09-telemetry.md
	renamed:    docs/docs/core/10-ocap.md -> docs/docs/develop/advanced/10-ocap.md
	renamed:    docs/docs/core/11-runtx_middleware.md -> docs/docs/develop/advanced/11-runtx_middleware.md
	renamed:    docs/docs/core/12-simulation.md -> docs/docs/develop/advanced/12-simulation.md
	renamed:    docs/docs/core/13-proto-docs.md -> docs/docs/develop/advanced/13-proto-docs.md
	renamed:    docs/docs/core/14-tips.md -> docs/docs/develop/advanced/14-tips.md
	renamed:    docs/docs/core/15-upgrade.md -> docs/docs/develop/advanced/15-upgrade.md
	renamed:    docs/docs/core/16-config.md -> docs/docs/develop/advanced/16-config.md
	renamed:    docs/docs/core/_category_.json -> docs/docs/develop/advanced/_category_.json
	renamed:    docs/docs/core/baseapp_state-begin_block.png -> docs/docs/develop/advanced/baseapp_state-begin_block.png
	renamed:    docs/docs/core/baseapp_state-checktx.png -> docs/docs/develop/advanced/baseapp_state-checktx.png
	renamed:    docs/docs/core/baseapp_state-commit.png -> docs/docs/develop/advanced/baseapp_state-commit.png
	renamed:    docs/docs/core/baseapp_state-deliver_tx.png -> docs/docs/develop/advanced/baseapp_state-deliver_tx.png
	renamed:    docs/docs/core/baseapp_state-initchain.png -> docs/docs/develop/advanced/baseapp_state-initchain.png
	renamed:    docs/docs/core/baseapp_state-prepareproposal.png -> docs/docs/develop/advanced/baseapp_state-prepareproposal.png
	renamed:    docs/docs/core/baseapp_state-processproposal.png -> docs/docs/develop/advanced/baseapp_state-processproposal.png
	renamed:    docs/docs/core/baseapp_state.png -> docs/docs/develop/advanced/baseapp_state.png
	renamed:    docs/docs/basics/00-app-anatomy.md -> docs/docs/develop/beginner/00-app-anatomy.md
	renamed:    docs/docs/basics/01-tx-lifecycle.md -> docs/docs/develop/beginner/01-tx-lifecycle.md
	renamed:    docs/docs/basics/02-query-lifecycle.md -> docs/docs/develop/beginner/02-query-lifecycle.md
	renamed:    docs/docs/basics/03-accounts.md -> docs/docs/develop/beginner/03-accounts.md
	renamed:    docs/docs/basics/04-gas-fees.md -> docs/docs/develop/beginner/04-gas-fees.md
	renamed:    docs/docs/basics/_category_.json -> docs/docs/develop/beginner/_category_.json
	renamed:    docs/docs/intro/00-overview.md -> docs/docs/develop/intro/00-overview.md
	renamed:    docs/docs/intro/01-why-app-specific.md -> docs/docs/develop/intro/01-why-app-specific.md
	renamed:    docs/docs/intro/02-sdk-app-architecture.md -> docs/docs/develop/intro/02-sdk-app-architecture.md
	renamed:    docs/docs/intro/03-sdk-design.md -> docs/docs/develop/intro/03-sdk-design.md
	renamed:    docs/docs/intro/_category_.json -> docs/docs/develop/intro/_category_.json
	deleted:    docs/docs/packages/README.md
	deleted:    docs/docs/tooling/README.md
	renamed:    docs/docs/run-node/00-keyring.md -> docs/docs/user/run-node/00-keyring.md
	renamed:    docs/docs/run-node/01-run-node.md -> docs/docs/user/run-node/01-run-node.md
	renamed:    docs/docs/run-node/02-interact-node.md -> docs/docs/user/run-node/02-interact-node.md
	renamed:    docs/docs/run-node/03-txs.md -> docs/docs/user/run-node/03-txs.md
	renamed:    docs/docs/run-node/05-run-testnet.md -> docs/docs/user/run-node/05-run-testnet.md
	renamed:    docs/docs/run-node/06-run-production.md -> docs/docs/user/run-node/06-run-production.md
	renamed:    docs/docs/run-node/_category_.json -> docs/docs/user/run-node/_category_.json
	modified:   docs/docusaurus.config.js
	modified:   docs/post.sh
	modified:   docs/pre.sh
	deleted:    docs/rfc/_category_.json

Unmerged paths:
  (use "git add/rm <file>..." as appropriate to mark resolution)
	deleted by us:   .github/workflows/deploy-docs.yml
	both modified:   UPGRADING.md
	both modified:   docs/docs/build/building-modules/01-module-manager.md
	both modified:   docs/docs/build/building-modules/06-keeper.md
	both modified:   docs/docs/develop/advanced/00-baseapp.md
	both modified:   docs/rfc/README.md

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/github/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally


Mergify commands and options

More conditions and actions can be found in the documentation.

You can also trigger Mergify actions by commenting on this pull request:

  • @Mergifyio refresh will re-evaluate the rules
  • @Mergifyio rebase will rebase this PR on its base branch
  • @Mergifyio update will merge the base branch into this PR
  • @Mergifyio backport <destination> will backport this PR on <destination> branch

Additionally, on Mergify dashboard you can:

  • look at your merge queues
  • generate the Mergify configuration with the config editor.

Finally, you can contact us on https://mergify.com

Co-authored-by: Julien Robert <[email protected]>
Co-authored-by: Marko <[email protected]>
Co-authored-by: marbar3778 <[email protected]>
(cherry picked from commit f198ea9)

# Conflicts:
#	.github/workflows/deploy-docs.yml
#	UPGRADING.md
#	docs/docs/build/building-modules/01-module-manager.md
#	docs/docs/build/building-modules/06-keeper.md
#	docs/docs/develop/advanced/00-baseapp.md
#	docs/rfc/README.md
@mergify mergify bot requested review from julienrbrt, tac0turtle and a team as code owners September 5, 2023 08:11
@mergify mergify bot added the conflicts label Sep 5, 2023
@mergify mergify bot mentioned this pull request Sep 5, 2023
20 tasks
mergify bot and others added 3 commits September 5, 2023 10:31
Co-authored-by: Julien Robert <[email protected]>
Co-authored-by: Marko <[email protected]>
Co-authored-by: marbar3778 <[email protected]>
(cherry picked from commit f198ea9)

# Conflicts:
#	.github/workflows/deploy-docs.yml
#	UPGRADING.md
#	docs/docs/build/building-modules/01-module-manager.md
#	docs/docs/build/building-modules/06-keeper.md
#	docs/docs/develop/advanced/00-baseapp.md
#	docs/rfc/README.md
…os/cosmos-sdk into mergify/bp/release/v0.50.x/pr-17459
Comment on lines 1 to 46
name: Deploy docs
# This job builds and deploys documenation to github pages.
# It runs on every push to main with a change in the docs folder.
on:
workflow_dispatch:
push:
branches:
- main
- "release/**"
paths:
- "docs/**"
- "x/**/*.md"
- .github/workflows/deploy-docs.yml

permissions:
contents: read

jobs:
build-and-deploy:
permissions:
contents: write # for JamesIves/github-pages-deploy-action to push changes in repo
runs-on: ubuntu-latest
steps:
- name: Checkout 🛎️
uses: actions/checkout@v4
with:
persist-credentials: false
fetch-depth: 0
path: "."

- name: Setup Node.js 🔧
uses: actions/setup-node@v3
with:
node-version: "16.x"

# npm install npm should be removed when https://github.com/npm/cli/issues/4942 is fixed
- name: Build 🔧
run: |
npm install -g [email protected]
make build-docs

# - name: Deploy 🚀
# uses: JamesIves/[email protected]
# with:
# branch: gh-pages
# folder: ~/output
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we can remove this file

docs/rfc/README.md Outdated Show resolved Hide resolved
@github-actions github-actions bot removed the Type: CI label Sep 5, 2023
@tac0turtle tac0turtle merged commit a980bf7 into release/v0.50.x Sep 5, 2023
41 checks passed
@tac0turtle tac0turtle deleted the mergify/bp/release/v0.50.x/pr-17459 branch September 5, 2023 13:57
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why this file has been merged with conflicts??

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants