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

Update Hardhat Tutorials to Use Hardhat Ignition Modules #902

Merged
merged 30 commits into from Apr 23, 2024

Conversation

themacexpert
Copy link
Contributor

@themacexpert themacexpert commented Apr 9, 2024

Description

This tutorial freshens up Hardhat tutorials to use Ignition modules to deploy smart contracts. Additionally, the Hardhat End to End tutorial was freshened up with some revised contract code and updated collators. Also updates terminal screenshots to terminyl.

Checklist

  • I have added a label to this PR 🏷️
  • I have run my changes through Grammarly
  • If this requires translations for the moonbeam-docs-cn repo, I have created a ticket for the translations in Jira
  • If pages have been moved around, I have created an additional PR in moonbeam-mkdocs to update redirects
  • If pages have been moved around, I have run the move-pages.py script to move the pages and update the image paths on the chinese repo
    • After the script has been run, I have created an additional PR in moonbeam-docs-cn
  • If images have been added, I have run the compress-images.py script to compress the images.
  • If variables (in variables.yml) need to be updated (such as a name change), I have updated the moonbeam-docs-cn repo to use the new variables
  • If this page requires a disclaimer, I have added one

Corresponding PRs

Please link to any corresponding PRs here.

After Translation Requirements

  • Will need to create PR in moonbeam-docs repo to remove images
  • Will need to create PR in moonbeam-docs repo to remove variables
  • Will need to create PR in moonbeam-mkdocs repo to add redirects for Chinese site
  • No additional PRs are required after the translations are done

Items to be Updated

Please list any of the items that will need to be added or deleted after the translations are done here.

@themacexpert themacexpert added the A1 - Maintenance Major Pull request contains major updates to an existing page (i.e., adding a new section, reorgs, etc.) label Apr 9, 2024
Copy link
Contributor

@eshaben eshaben left a comment

Choose a reason for hiding this comment

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

Sweeeet!! A couple things:

  • I applied feedback on the dev-environments/hardhat page that should also be applied to the tutorial
  • We have to keep the CN site in working order, so we need to keep the images. Make sure to update the checklist to reflect that the images need to be removed post-translation.

builders/build/eth-api/dev-env/hardhat.md Outdated Show resolved Hide resolved
builders/build/eth-api/dev-env/hardhat.md Show resolved Hide resolved
builders/build/eth-api/dev-env/hardhat.md Outdated Show resolved Hide resolved
builders/build/eth-api/dev-env/hardhat.md Outdated Show resolved Hide resolved
builders/build/eth-api/dev-env/hardhat.md Outdated Show resolved Hide resolved
tutorials/eth-api/hardhat-start-to-end.md Outdated Show resolved Hide resolved
tutorials/eth-api/hardhat-start-to-end.md Outdated Show resolved Hide resolved
themacexpert and others added 9 commits April 11, 2024 14:17
Co-authored-by: Erin Shaben <eshaben@icloud.com>
…g/StakingInterface.sol

Co-authored-by: Erin Shaben <eshaben@icloud.com>
Co-authored-by: Erin Shaben <eshaben@icloud.com>
Co-authored-by: Erin Shaben <eshaben@icloud.com>
Co-authored-by: Erin Shaben <eshaben@icloud.com>
Copy link
Contributor

@eshaben eshaben left a comment

Choose a reason for hiding this comment

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

Looks like some of the images still need to be restored for the chinese docs.

Can you just go through and make sure all the snippets in the hardhat tutorial have been cleaned up with prettier? Also take a look at the really long comments and how those are displayed on the actual page. If it makes sense or looks better to break them up yourself, please do that.

Thanks!

tutorials/eth-api/hardhat-start-to-end.md Show resolved Hide resolved
tutorials/eth-api/hardhat-start-to-end.md Outdated Show resolved Hide resolved
tutorials/eth-api/hardhat-start-to-end.md Outdated Show resolved Hide resolved
tutorials/eth-api/hardhat-start-to-end.md Show resolved Hide resolved
tutorials/eth-api/hardhat-start-to-end.md Outdated Show resolved Hide resolved
tutorials/eth-api/hardhat-start-to-end.md Outdated Show resolved Hide resolved
tutorials/eth-api/hardhat-start-to-end.md Outdated Show resolved Hide resolved
themacexpert and others added 5 commits April 18, 2024 09:54
…/deploy-moonbase.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>
…/deploy-moonbeam.md

Co-authored-by: Erin Shaben <eshaben@icloud.com>
Co-authored-by: Erin Shaben <eshaben@icloud.com>
@themacexpert
Copy link
Contributor Author

Looks like some of the images still need to be restored for the chinese docs.

Can you just go through and make sure all the snippets in the hardhat tutorial have been cleaned up with prettier? Also take a look at the really long comments and how those are displayed on the actual page. If it makes sense or looks better to break them up yourself, please do that.

Thanks!

Cn images are all added back, none are removed in this pr

Copy link
Contributor

@eshaben eshaben left a comment

Choose a reason for hiding this comment

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

a couple of minor things, but looks good!!

themacexpert and others added 3 commits April 22, 2024 15:26
…est-file.js

Co-authored-by: Erin Shaben <eshaben@icloud.com>
Co-authored-by: Erin Shaben <eshaben@icloud.com>
Copy link
Contributor

@eshaben eshaben left a comment

Choose a reason for hiding this comment

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

LGTM! ✨

@eshaben eshaben merged commit d379bf5 into master Apr 23, 2024
1 check passed
@eshaben eshaben deleted the themacexpert/hardhat branch April 23, 2024 16:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A1 - Maintenance Major Pull request contains major updates to an existing page (i.e., adding a new section, reorgs, etc.)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants