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

Rc docs #2409

Merged
merged 66 commits into from
Mar 1, 2024
Merged

Rc docs #2409

merged 66 commits into from
Mar 1, 2024

Conversation

yaruno
Copy link
Contributor

@yaruno yaruno commented Mar 1, 2024

Summary

1.0 documentation update
Config wizard mainnet description update

Changes

Terminology updates
Client library naming scheme updates
Docker package naming scheme updates
Operator upgrade instructions

Limitations and future improvements

Provide a bullet list or description of known omissions or limitations of the
solution and/or any ideas for future improvement. Leave section ouf if
not applicable.

Checklist before requesting a review

  • Is this a breaking change? If it is, be clear in summary.
  • Read through code myself one more time.
  • Make sure any and all TODO comments left behind are meant to be left in.
  • Has reasonable passing test coverage?
  • Updated changelog if applicable.
  • Updated documentation if applicable.

jtakalai and others added 30 commits November 4, 2023 15:04
breaks in some browsers (maybe there's local markdown re-render?)

the link should be https://docs.streamr.network/guides/become-an-operator/

but it becomes https://docs.streamr.network/guides/how-to-run-streamr-node/become-an-operator probably because the current page is https://docs.streamr.network/guides/how-to-run-streamr-node/ with a slash in the end
I did the NPM path
## Summary

Prepended a missing `v` to `100.0.0-pretestnet.3`:
`v100.0.0-pretestnet.3`.

If node operators paste the string without the `v` prepended e.g. as
such: `sudo docker run -p 32200:32200 --name streamr --restart
unless-stopped -d -v $(cd ~/.streamrDocker &&
pwd):/home/streamr/.streamr streamr/broker-node:100.0.0-pretestnet.3`
instead of `sudo docker run -p 32200:32200 --name streamr --restart
unless-stopped -d -v $(cd ~/.streamrDocker &&
pwd):/home/streamr/.streamr streamr/broker-node:v100.0.0-pretestnet.3`,
updating the Docker container image will fail.

## Limitations and future improvements

Perhaps add detailed update instructions to the testnets FAQ :)
@yaruno yaruno requested review from harbu and hpihkala March 1, 2024 12:25
@github-actions github-actions bot added the broker Related to Broker Package label Mar 1, 2024
@yaruno yaruno merged commit b1736c6 into main Mar 1, 2024
24 checks passed
@yaruno yaruno deleted the rc-docs branch March 1, 2024 13:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
broker Related to Broker Package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants