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

docs: add Quick Start about running Axon and Blockscan Locally with Docker #1364

Merged
merged 2 commits into from
Aug 28, 2023

Conversation

Flouse
Copy link
Contributor

@Flouse Flouse commented Aug 25, 2023

What this PR does / why we need it?

This PR is prepared for the Quick Start: Running Axon and Blockscan Locally with Docker documentation.

What is the impact of this PR?

  • No Breaking Change

Special notes for your reviewer:

  • Shall we delete the docker-compose in file project root?
    Is it being used somewhere?
CI Settings

CI Usage

Tip: Check the CI you want to run below, and then comment /run-ci.

CI Switch

  • Coverage Test
  • E2E Tests
  • Code Format
  • Web3 Compatible Tests
  • OCT 1-5 And 12-15
  • OCT 6-10
  • OCT 11
  • OCT 16-19
  • v3 Core Tests

CI Description

CI Name Description
Chaos CI Test the liveness and robustness of Axon under terrible network condition
Cargo Clippy Run cargo clippy --all --all-targets --all-features
Coverage Test Get the unit test coverage report
E2E Test Run end-to-end test to check interfaces
Code Format Run cargo +nightly fmt --all -- --check and cargo sort -gwc
Web3 Compatible Test Test the Web3 compatibility of Axon
v3 Core Test Run the compatibility tests provided by Uniswap V3
OCT 1-5 | 6-10 | 11 | 12-15 | 16-19 Run the compatibility tests provided by OpenZeppelin

@Flouse Flouse added documentation github_actions Pull requests that update GitHub Actions code labels Aug 25, 2023
@Flouse Flouse requested a review from Simon-Tl August 25, 2023 09:46
@Flouse Flouse self-assigned this Aug 25, 2023
@Flouse
Copy link
Contributor Author

Flouse commented Aug 25, 2023

Special notes for your reviewer:

  • Shall we delete the docker-compose file in project root?
    Is it being used somewhere?

cc @KaoImin

@Flouse Flouse changed the title docs: add a Quick Start to run Axon and Blockscan Locally with Docker docs: add Quick Start about running Axon and Blockscan Locally with Docker Aug 25, 2023
@Flouse Flouse changed the base branch from 0.2.0-dev to main August 28, 2023 01:52
@Flouse Flouse marked this pull request as ready for review August 28, 2023 01:52
@Flouse Flouse requested a review from a team as a code owner August 28, 2023 01:52
@Flouse Flouse requested review from blckngm and KaoImin and removed request for blckngm August 28, 2023 01:52
@Flouse Flouse requested a review from linnnsss August 28, 2023 01:56
KaoImin
KaoImin previously approved these changes Aug 28, 2023
Copy link
Contributor

@linnnsss linnnsss left a comment

Choose a reason for hiding this comment

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

Please consider implementing a few subtle modifications to enhance both the style and language

devtools/chain/README.md Outdated Show resolved Hide resolved
devtools/chain/README.md Outdated Show resolved Hide resolved
devtools/chain/README.md Outdated Show resolved Hide resolved
devtools/chain/README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@linnnsss linnnsss left a comment

Choose a reason for hiding this comment

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

lgtm

@Flouse Flouse merged commit 68f7d2c into main Aug 28, 2023
@Flouse Flouse deleted the docs-quick-start branch August 28, 2023 10:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
document github_actions Pull requests that update GitHub Actions code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants