status-im
/
nimbus-eth2
mirror of https://github.com/status-im/nimbus-eth2.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

remove references to devel

This commit is contained in:
yslcrypto 2021-04-28 16:06:00 +02:00
parent ec1aa622b0
commit 4cdbc17e39
2 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/the_nimbus_book/src/contribute.md
View File

@ -17,27 +17,27 @@ We use an utility tool called mdBook to create online books from Markdown files.
## Build and Deploy ## Build and Deploy
The first step is to submit a pull request to the [devel branch](https://github.com/status-im/nimbus-eth2/tree/devel). The first step is to submit a pull request to the [unstable branch](https://github.com/status-im/nimbus-eth2/tree/unstable).
Then, after it is merged, do the following under our main repository: Then, after it is merged, do the following under our main repository:
1. `cd nimbus-eth2` 1. `cd nimbus-eth2`
2. `git checkout devel` 2. `git checkout unstable`
3. `git pull` 3. `git pull`
4. `make update` (This is to update the submodules to the latest version) 4. `make update` (This is to update the submodules to the latest version)
5. `make publish-book` 5. `make publish-book`
## Trouble Shooting ## Troubleshooting
If you see file conflicts in the pull request, this may due to that you have created your new branch from an old version of the `devel` branch. Update your new branch using the following commands: If you see file conflicts in the pull request, this may due to that you have created your new branch from an old version of the `unstable` branch. Update your new branch using the following commands:
``` ```
git checkout devel git checkout unstable
git pull git pull
make update make update
git checkout readme git checkout readme
git merge devel git merge unstable
# use something like `git mergetool` to resolve conflicts, then read the instructions for completing the merge (usually just a `git commit`) # use something like "git mergetool" to resolve conflicts, then read the instructions for completing the merge (usually just a `git commit`)
# check the output of `git diff devel` # check the output of "git diff unstable"
``` ```
Thank you so much for your help to the decentralized and open source community. :) Thank you so much for your help to the decentralized and open source community. :)

2
docs/the_nimbus_book/src/troubleshooting.md
View File

@ -5,7 +5,7 @@
As it stands, we are continuously making improvements to both stability and memory usage. So please make sure you keep your client up to date! This means restarting your node and updating your software regularly from the `master` branch. If you can't find a solution to your problem here, feel free to hit us up on our [discord](https://discord.com/invite/XRxWahP)! As it stands, we are continuously making improvements to both stability and memory usage. So please make sure you keep your client up to date! This means restarting your node and updating your software regularly from the `master` branch. If you can't find a solution to your problem here, feel free to hit us up on our [discord](https://discord.com/invite/XRxWahP)!
> **Note:** While the `master` branch of the `nimbus-eth2` repository is more stable, the latest updates happen in the `devel` branch which is (usually) merged into master every week on Tuesday. If you choose to run Nimbus directly from the `devel` branch, be prepared for instabilities! > **Note:** While the `stable` branch of the `nimbus-eth2` repository is more stable, the latest updates happen in the `unstable` branch which is (usually) merged into master every week on Tuesday. If you choose to run Nimbus directly from the `unstable` branch, be prepared for instabilities!
To update and restart, run `git pull`, `make update`, followed by `make nimbus_beacon_node`: To update and restart, run `git pull`, `make update`, followed by `make nimbus_beacon_node`: