This repository has been archived by the owner on Jan 24, 2022. It is now read-only.
Renaming in docs #1086
Merged
Renaming in docs #1086
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Wow, that was big @spalladino! I left some comments, most of them nits we might want to discuss in order to be aligned in both READMEs that I'm working on and the docsite.
| Using `zos push --network geth_ropsten` or `zos push --network parity_ropsten` will both produce a file named `zos.ropsten.json` no matter which method was used to connect to the ropsten network. ZeppelinOS will automatically detect which public network is being referred to (using web3.network.getVersion()) and use this information for determining the file name. | ||
| When dealing with local networks, ZeppelinOS will generate files with `dev-<network_id>`, given that these networks are not public and don't have a canonical name. Using `zos push --network local` will produce a file named `zos.dev-1540303312049.json` (or some other number representing the network id of the local network). | ||
| Using `openzeppelin push --network geth_ropsten` or `openzeppelin push --network parity_ropsten` will both produce a file named `ropsten.json` no matter which method was used to connect to the ropsten network. OpenZeppelin SDK will automatically detect which public network is being referred to (using web3.network.getVersion()) and use this information for determining the file name. | ||
| When dealing with local networks, OpenZeppelin SDK will generate files with `dev-<network_id>`, given that these networks are not public and don't have a canonical name. Using `openzeppelin push --network local` will produce a file named `dev-1540303312049.json` (or some other number representing the network id of the local network). |
There was a problem hiding this comment.
It feels weird to read OpenZeppelin SDK without a The before in some cases, but I'm not sure when to include it or not...
There was a problem hiding this comment.
Good catch. I'm including it whenever it is used as a noun, not as an adjective:
- "When dealing with local networks, the OpenZeppelin SDK will generate files..."
- "And link your OpenZeppelin SDK project to the..."
|
@jcarpanelli thanks so much for reviewing! Ready for another round. |
Closed
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Applies renaming for new branding in docs. It is suggested to review this PR commit-by-commit.