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.

Sign up for GitHub

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

Add Netlify to rtd #3598

Merged
merged 2 commits into from
Jun 23, 2020
Merged

Add Netlify to rtd #3598

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
81776e9
add netlify to readthedocs
ryanio Jun 23, 2020
a781405
various docs fixups
ryanio Jun 23, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions RELEASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ The following describes the steps required to release a new version of `web3.js`
1. Create release commit and tags e.g. `lerna version 1.2.7-rc.0 --no-push`
1. (updates package version numbers, builds minified file (for `1.x`), creates release commit and tags.)
1. For `1.x`, save [index.html](https://github.com/ethereum/web3.js/blob/1.x/scripts/html/index.html) to your local machine and test loading minified file to ensure its integrity. Be sure to delete `index.html` after.
1. Check git working state is clean. Sometimes files modified by gulp are not included. If so, run `git commit --amend` and `git tag -d 1.2.7-rc.0` and `git tag 1.2.7-rc.0`.
1. Check git working state is clean. Sometimes files modified by gulp are not included. If so, run `git commit --amend` and `git tag -d 1.2.7-rc.0` and `git tag 1.2.7-rc.0`.
1. Push release branch to origin with tags `git push origin release/1.2.7 --follow-tags`.
1. Create release PR as draft ([example](https://github.com/ethereum/web3.js/pull/3351)).
1. Ensure CI is green / passing.
Expand All @@ -94,11 +94,11 @@ The following describes the steps required to release a new version of `web3.js`
1. (The build may sometimes need to be manually triggered in ReadTheDocs admin panel. If the version does not appear, create a build of a previous version to refresh the list.)
1. Activate the new version.
1. Request PR review from key contributors:
1. Chris from EthereumJS ([@cgewecke](https://github.com/cgewecke))
1. Patricio from Nomic Labs ([@alcuadrado](https://github.com/alcuadrado))
1. Michael from Embark ([@michaelsbradleyjr](https://github.com/michaelsbradleyjr))
1. Nicholas from Truffle ([@gnidan](https://github.com/gnidan))
1. If touches or affects ENS: Nick Johnson ([@Arachnid](https://github.com/Arachnid))
1. Chris from EthereumJS ([@cgewecke](https://github.com/cgewecke))
1. Patricio from Nomic Labs ([@alcuadrado](https://github.com/alcuadrado))
1. Michael from Embark ([@michaelsbradleyjr](https://github.com/michaelsbradleyjr))
1. Nicholas from Truffle ([@gnidan](https://github.com/gnidan))
1. If touches or affects ENS: Nick Johnson ([@Arachnid](https://github.com/Arachnid))
1. Wait 1 week for community discourse and 2 reviewer approvals.
1. (if release is an emergency patch, time limit may be reduced relative to severity.)

Expand All @@ -107,7 +107,7 @@ The following describes the steps required to release a new version of `web3.js`
1. Create GitHub draft release from text of `rc` release.
1. Checkout release branch (e.g. `release/1.2.7`).
1. Create and push release commit and tags: `lerna version 1.2.7 --force-publish --no-push`
1. Check git working state is clean. Sometimes files modified by gulp are not included. If so, run `git commit --amend` and `git tag -d 1.2.7` and `git tag 1.2.7`.
1. Check git working state is clean. Sometimes files modified by gulp are not included. If so, run `git commit --amend` and `git tag -d 1.2.7` and `git tag 1.2.7`.
1. Push release branch to origin with tags `git push origin release/1.2.7 --follow-tags`.
1. Publish the GitHub release.
1. A GitHub Webhook should trigger the ReadTheDocs build after the release is published.
Expand All @@ -127,4 +127,4 @@ The following describes the steps required to release a new version of `web3.js`
1. Santiago from OpenZeppelin ([@spalladino](https://github.com/spalladino))
1. Pedro from WalletConnect ([@pedrouid](https://github.com/pedrouid))
1. Josh from FunFair ([@joshstevens19](https://github.com/joshstevens19))
1. Truffle, Gnosis, Aragon, Embark, Alchemy, Buidler, Remix
1. Truffle, Gnosis, Aragon, Embark, Alchemy, Buidler, Remix
12 changes: 7 additions & 5 deletions docs/getting-started.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
Getting Started
===============

The web3.js library is a collection of modules that contain specific functionality for the ethereum ecosystem.
The web3.js library is a collection of modules that contain functionality for the ethereum ecosystem.

- ``web3-eth`` is for the ethereum blockchain and smart contracts.
- ``web3-shh`` is for the whisper protocol to communicate p2p and broadcast.
- ``web3-shh`` is for the whisper protocol, to communicate p2p and broadcast.
- ``web3-bzz`` is for the swarm protocol, the decentralized file storage.
- ``web3-utils`` contains useful helper functions for Dapp developers.

Expand All @@ -27,14 +27,16 @@ First you need to get web3.js into your project. This can be done using the foll

After that you need to create a web3 instance and set a provider.

Most Ethereum-supported browsers like MetaMask and TrustWallet have an [EIP-1193](https://eips.ethereum.org/EIPS/eip-1193) compliant provider available at ``window.ethereum``. For web3.js, check ``Web3.givenProvider``.
Most Ethereum-supported browsers like MetaMask have an `EIP-1193 <https://eips.ethereum.org/EIPS/eip-1193>`_ compliant provider available at ``window.ethereum``.

For web3.js, check ``Web3.givenProvider``.

If this property is ``null`` you should connect to a remote/local node.

.. code-block:: javascript

// in node.js use: var Web3 = require('web3');
// In Node.js use: const Web3 = require('web3');

var web3 = new Web3(Web3.givenProvider || "ws://localhost:8545");
let web3 = new Web3(Web3.givenProvider || "ws://localhost:8545");

That's it! now you can use the ``web3`` object.
8 changes: 4 additions & 4 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,9 @@
web3.js - Ethereum JavaScript API
=================================

web3.js is a collection of libraries that allow you to interact with a local or remote ethereum node
using HTTP, IPC or WebSocket.
web3.js is a collection of libraries that allow you to interact with a local or remote ethereum node using HTTP, IPC or WebSocket.

The following documentation will guide you through :ref:`installing and running web3.js <adding-web3>`
as well as providing an :ref:`API reference documentation <#id1>` with examples.
The following documentation will guide you through :ref:`installing and running web3.js <adding-web3>` as well as providing an :ref:`API reference documentation <#id1>` with examples.

Contents:

Expand Down Expand Up @@ -41,3 +39,5 @@ Contents:
web3-utils
web3-admin


Special thanks to `Netlify <https://www.netlify.com/>`_ for providing build and deploy services for our end-to-end integration tests.