matic-docs
matic-docs copied to clipboard
maticnetwork
Update Node Binary Installation Guide
Update node binary installation guide for new CLI version (0.3.x)
This commit will deprecate old CLI. Install guide with binaries and ansible will be marked as legacy. A new guide page will be created to ask users to install binaries with an installation script directly. The new guide will make node binary installation and update easier for users.
The new installation script hasn't been open sourced yet. We will hold this PR until the script is open sourced.
Hi @cffls, thanks for this - I'd advise us to keep the existing documentation instead of replacing it
Thanks Danny, that is a good point. I will try keeping existing docs and add new things on top of it.
@Nazeim Thanks for pushing this forward! ☺️ However, I am still working on this PR, as some components are not finalized yet. I will remove "WIP" tag once the work has completed.
@Nazeim @vcastellm I've completed the first version of this draft. Please review. Just in case, two new files, full-node.md and run-validator.md, are folded by default, please make sure to expand and read them. Thank you!
Adding DNM until we push https://github.com/maticnetwork/matic-docs/pull/882
Thank you @DannyS03 for proofreading and applying changes to the PR! Really appreciate your help. However, we can't merge this PR yet, because v0.3.0 of Bor and Heimdall have not been officially released. We are still in the testing phase and there still could be some changes to Bor and Heimdall in the future. Please hold this PR until we have finalized v0.3.0 and ready to notify external validators. I will remove the "DNM" tag once we are ready from our side. Thank you again for your helps!
@cffls feel free to let us know when all desired contributions have been made
Would be interesting to add running under docker docs? maybe in another PR?
@vcastellm Docker docs will be a good idea, but I'd put it in another PR, since this PR is mostly for changing existing docs.
@DannyS03 We are still in testing phase. I will notify you when everything is finalized. Thank you!
⚠️ GitGuardian has uncovered 1 secret following the scan of your pull request.
Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.
🔎 Detected hardcoded secret in your pull request
| GitGuardian id | Secret | Commit | Filename | |
|---|---|---|---|---|
| - | Algolia Keys | 360a028445f1a5f2c2d650528efb2d0159c4d4d3 | docusaurus.config.js | View secret |
🛠 Guidelines to remediate hardcoded secrets
- Understand the implications of revoking this secret by investigating where it is used in your code.
- Replace and store your secret safely. Learn here the best practices.
- Revoke and rotate this secret.
- If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.
To avoid such incidents in the future consider
- following these best practices for managing and storing secrets including API keys and other credentials
- install secret detection on pre-commit to catch secret before it leaves your machine and ease remediation.
🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.
Our GitHub checks need improvements? Share your feedbacks!
![gitguardian[bot] avatar](https://avatars.githubusercontent.com/in/46505?v=4 "Published by a pub.dev verified publisher"){kind=small}
Hi @Nazeim, sorry about the late response. There are some new changes coming to v0.3.0. I will update this PR within this week.
Sorry @Nazeim, it is not ready to merge yet. We are still working on some toolings. I will update this thread once we are ready to merge. Thank you!