Skip to content

Commit

Permalink
Merge branch 'update-10-02-2020' into 'master'
Browse files Browse the repository at this point in the history
Make markdown links point to relative html files

See merge request zcash-docs/zcash-docs!227
  • Loading branch information
lindanlee committed Oct 2, 2020
2 parents 6152a73 + 8ba1402 commit 98c2eb4
Show file tree
Hide file tree
Showing 8 changed files with 27 additions and 27 deletions.
10 changes: 5 additions & 5 deletions source/rtd_pages/Debian-Ubuntu-build.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# Building Zcashd & Zcash-cli on Debian/Ubuntu

*Please upgrade!* [End of Debian Jessie support is on October 1st 2020.](https://forum.zcashcommunity.com/t/end-of-debian-jessie-support-is-on-october-1st-2020/37313)
*Please upgrade!* [End of Debian Jessie support was on October 1st 2020.](https://forum.zcashcommunity.com/t/end-of-debian-jessie-support-is-on-october-1st-2020/37313)


Zcashd & Zcash-cli are [officially supported](https://zcash.readthedocs.io/en/latest/rtd_pages/supported_platform_policy.html) for Debian/Ubuntu. Since Debian/Ubuntu is the best supported platform, we recommend running Zcashd & Zcash-cli on Debian/Ubuntu if possible.
Zcashd & Zcash-cli are [officially supported](supported_platform_policy.html) for Debian/Ubuntu. Since Debian/Ubuntu is the best supported platform, we recommend running Zcashd & Zcash-cli on Debian/Ubuntu if possible.

## Instructions

There are multiple ways to download dependencies and build Zcashd & Zcash-cli. We've listed the various ways, in order of recommendation (try the packages first!).

* [Debian Packages Setup](https://zcash.readthedocs.io/en/latest/rtd_pages/install_debian_bin_packages.html); below video follows these instructions.
* [Debian Packages Setup](install_debian_bin_packages.html); below video follows these instructions.

<iframe width="560" height="315" src="https://www.youtube.com/embed/hTKL0jPu7X0" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>

Expand Down Expand Up @@ -44,9 +44,9 @@ There are multiple ways to download dependencies and build Zcashd & Zcash-cli. W
(If you don't have ``nproc``, then substitute the number of cores on your system. If the build runs out of memory, try again without the ``-j`` argument, i.e. just ``./zcutil/build.sh``.)


* [Binary Tarball Download and Setup](https://zcash.readthedocs.io/en/latest/rtd_pages/install_binary_tarball.html)
* [Binary Tarball Download and Setup](install_binary_tarball.html)

The .tar file unzips into a directory and does not involve a package manager, so it is agnostic of whether that system uses an OS package manager or which one it uses.

## Next steps
Now that you've built Zcashd & Zcash-cli, we can move on to the next steps of: configuration, sync, and use. Refer back to the [Zcashd & Zcash-cli page](https://zcash.readthedocs.io/en/latest/rtd_pages/zcashd.html) for further instructions.
Now that you've built Zcashd & Zcash-cli, we can move on to the next steps of: configuration, sync, and use. Refer back to the [Zcashd & Zcash-cli page](zcashd.html) for further instructions.
4 changes: 2 additions & 2 deletions source/rtd_pages/Linux-misc-build.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Building Zcashd & Zcash-cli on Linux

Zcashd & Zcash-cli are "best effort" supported for non-Debian/Ubuntu Linux OSes. It's ok to use it and develop on it--we sure do. The level of testing and integration is not up to par with our standards to call this [officially supported](https://zcash.readthedocs.io/en/latest/rtd_pages/supported_platform_policy.html#supported-platform-policy).
Zcashd & Zcash-cli are "best effort" supported for non-Debian/Ubuntu Linux OSes. It's ok to use it and develop on it--we sure do. The level of testing and integration is not up to par with our standards to call this [officially supported](supported_platform_policy.html#supported-platform-policy).

## Instructions

Expand Down Expand Up @@ -56,4 +56,4 @@ Currently, the only way to install Zcashd & Zcash-cli on Linux is to build from
If you don't have ``nproc``, then substitute the number of cores on your system. If the build runs out of memory, try again without the ``-j`` argument, i.e. just ``./zcutil/build.sh``

## Next steps
Now that you've built Zcashd & Zcash-cli, we can move on to the next steps of: configuration, sync, and use. Refer back to the [Zcashd & Zcash-cli page](https://zcash.readthedocs.io/en/latest/rtd_pages/zcashd.html) for further instructions.
Now that you've built Zcashd & Zcash-cli, we can move on to the next steps of: configuration, sync, and use. Refer back to the [Zcashd & Zcash-cli page](zcashd.html) for further instructions.
4 changes: 2 additions & 2 deletions source/rtd_pages/OSx-build.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Building Zcashd & Zcash-cli on OSx


Zcashd & Zcash-cli are "best effort" supported for macOS. It's ok to use it and develop on it--we sure do. The level of testing and integration is not up to par with our standards to call this [officially supported](https://zcash.readthedocs.io/en/latest/rtd_pages/supported_platform_policy.html#supported-platform-policy).
Zcashd & Zcash-cli are "best effort" supported for macOS. It's ok to use it and develop on it--we sure do. The level of testing and integration is not up to par with our standards to call this [officially supported](supported_platform_policy.html).

## Instructions

Expand Down Expand Up @@ -53,4 +53,4 @@ Currently, the only way to install Zcashd & Zcash-cli on OSx is to build from so


## Next steps
Now that you've built Zcashd & Zcash-cli, we can move on to the next steps of: configuration, sync, and use. Refer back to the [Zcashd & Zcash-cli page](https://zcash.readthedocs.io/en/latest/rtd_pages/zcashd.html) for further instructions.
Now that you've built Zcashd & Zcash-cli, we can move on to the next steps of: configuration, sync, and use. Refer back to the [Zcashd & Zcash-cli page](zcashd.html) for further instructions.
2 changes: 1 addition & 1 deletion source/rtd_pages/best_practices.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Development Best Practices

We pledge to respect all contributors. In the interest of fostering an open and welcoming community, we also expect contributors to adhere to the [contributor code of conduct](https://zcash.readthedocs.io/en/latest/rtd_pages/code_of_conduct.html).
We pledge to respect all contributors. In the interest of fostering an open and welcoming community, we also expect contributors to adhere to the [contributor code of conduct](code_of_conduct.html).

## Development workflow

Expand Down
4 changes: 2 additions & 2 deletions source/rtd_pages/dev_tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Thee [Zcash RPC webpage](https://zcash-rpc.github.io/) makes it easy to look at

## Public Test Network

The [Zcash testnet](https://zcash.readthedocs.io/en/latest/rtd_pages/testnet_guide.html) is a blockchain that attempts to mimic the main Zcash network for testing purposes, with its own coins that hold no monetary value (TAZ). It's used by developers to experiment with Zcash apps having to use Zcash (ZEC) and test network upgrades before activating on the main Zcash network. Since it's public and long-running, you can see a lot of historical data, and interact with many peers.
The [Zcash testnet](testnet_guide.html) is a blockchain that attempts to mimic the main Zcash network for testing purposes, with its own coins that hold no monetary value (TAZ). It's used by developers to experiment with Zcash apps having to use Zcash (ZEC) and test network upgrades before activating on the main Zcash network. Since it's public and long-running, you can see a lot of historical data, and interact with many peers.

## Private Containerized Network

Expand All @@ -18,7 +18,7 @@ The [Zcash testnet-in-a-box (TNB)](https://github.com/zcash-hackworks/zcash-test

## Block Explorer

By default, zcashd will operate as a full node and wallet. However, zcashd can alternatively be run as a [full node with access to a block explorer](https://zcash.readthedocs.io/en/latest/rtd_pages/insight_explorer.html), which allows it to see and fetch additonal fields (i.e. utxos, spent txid). This zcashd mode is commonly used along with zcash-cli to service exchanges, wallets, and other zcash services, but cannot be used as a wallet itself since it will contain no private keys.
By default, zcashd will operate as a full node and wallet. However, zcashd can alternatively be run as a [full node with access to a block explorer](insight_explorer.html), which allows it to see and fetch additonal fields (i.e. utxos, spent txid). This zcashd mode is commonly used along with zcash-cli to service exchanges, wallets, and other zcash services, but cannot be used as a wallet itself since it will contain no private keys.

<!--## todo-->
<!--grafana dashboard-->
Expand Down
2 changes: 1 addition & 1 deletion source/rtd_pages/protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ The most up-to-date [Zcash Protocol Specification](https://zips.z.cash/protocol/

## Network Upgrade Guide

The [Network Upgrade Guide](https://zcash.readthedocs.io/en/latest/rtd_pages/nu_dev_guide.html) gives advice on how to stay current with the Zcash protocol and network. It also details the changes made with each network upgrade, and if and how those changes necessitate changes on supporting services. Network upgrades on a bi-annual basis to maintain the Zcash network.
The [Network Upgrade Guide](nu_dev_guide.html) gives advice on how to stay current with the Zcash protocol and network. It also details the changes made with each network upgrade, and if and how those changes necessitate changes on supporting services. Network upgrades on a bi-annual basis to maintain the Zcash network.
2 changes: 1 addition & 1 deletion source/rtd_pages/windows-build.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ We do not currently support Zcashd & Zcash-cli on Windows.

We do not have documented instructions to build Zcashd & Zcash-cli on Windows, and do not recommend doing so.

However, it is technically possible to run on them on Windows with a cross-compile from Debian. Follow the [install process for Debian/Ubuntu](./Debian-Ubuntu-build.md), and then run the following command to cross-compile for Windows: ```HOST=x86_64-w64-mingw32 ./zcutil/build.sh -j$(nproc)```.
However, it is technically possible to run on them on Windows with a cross-compile from Debian. Follow the [install process for Debian/Ubuntu](Debian-Ubuntu-build.html), and then run the following command to cross-compile for Windows: ```HOST=x86_64-w64-mingw32 ./zcutil/build.sh -j$(nproc)```.

Next, transfer the binary over to a Windows machine to run Zcashd & Zcash-cli on Windows. Updating Zcashd & Zcash-cli on Windows will require a cross-compile every time. For this reason, if you are able to run Zcashd & Zcash-cli on another operating system, we recommend doing that instead.
26 changes: 13 additions & 13 deletions source/rtd_pages/zcashd.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@ Zcashd & Zcash-cli are maintained by Electric Coin Company (the founding team fo

* [Docker](https://hub.docker.com/r/electriccoinco/zcashd) (containerized DebianOS)

* [Debian/Ubuntu](https://zcash.readthedocs.io/en/latest/rtd_pages/Debian-Ubuntu-build.html) ([officially](https://zcash.readthedocs.io/en/latest/rtd_pages/supported_platform_policy.html#supported-platform-policy) supported) *[Debian Jessie support ends on Oct 1st 2020.](https://forum.zcashcommunity.com/t/end-of-debian-jessie-support-is-on-october-1st-2020/37313)*
* [Debian/Ubuntu](Debian-Ubuntu-build.html) ([officially](https://zcash.readthedocs.io/en/latest/rtd_pages/supported_platform_policy.html#supported-platform-policy) supported) *[Debian Jessie support ends on Oct 1st 2020.](https://forum.zcashcommunity.com/t/end-of-debian-jessie-support-is-on-october-1st-2020/37313)*

* [Other Linux Systems](https://zcash.readthedocs.io/en/latest/rtd_pages/Linux-misc-build.html) ("best-effort" supported)

* [OSx](https://zcash.readthedocs.io/en/latest/rtd_pages/OSx-build.html) ("best-effort" supported)
* [OSx](OSx-build.html) ("best-effort" supported)

* [Windows](https://zcash.readthedocs.io/en/latest/rtd_pages/windows-build.html) (unsupported)
* [Windows](windows-build.html) (unsupported)


## Configuration
Expand All @@ -31,7 +31,7 @@ mkdir -p ~/.zcash
touch ~./zcash/zcash.conf
```

Zcashd can be configured in various ways to suit different use cases; see the [Zcash.conf guide](https://zcash.readthedocs.io/en/latest/rtd_pages/zcash_conf_guide.html) for an extensive list of options.
Zcashd can be configured in various ways to suit different use cases; see the [Zcash.conf guide](zcash_conf_guide.html) for an extensive list of options.

## Use

Expand Down Expand Up @@ -78,17 +78,17 @@ Helpful tips:
```
* Running ``make clean`` before building the update can eliminate random known link errors.
* If you don't have ``nproc`` or if the build runs out of memory, try again without the ``-j`` argument, just ``./zcutil/build.sh``.
* If you run into issues upgrading, please see the [Network Upgrade Guide](https://zcash.readthedocs.io/en/latest/rtd_pages/nu_dev_guide.html).
* If you run into issues upgrading, please see the [Network Upgrade Guide](nu_dev_guide.html).

## References

An extensive list of Zcashd & Zcash-cli pages, including ones linked inline in this page above.
* [Zcash RPC Commands](https://zcash-rpc.github.io/)
* [Zcash.conf guide](https://zcash.readthedocs.io/en/latest/rtd_pages/zcash_conf_guide.html)
* [Troubleshooting Guide](https://zcash.readthedocs.io/en/latest/rtd_pages/troubleshooting_guide.html)
* [Wallet Backup Instructions](https://zcash.readthedocs.io/en/latest/rtd_pages/wallet_backup.html)
* [Sending Memos with Zcashd](https://zcash.readthedocs.io/en/latest/rtd_pages/memos.html)
* [Zcash Mining guide](https://zcash.readthedocs.io/en/latest/rtd_pages/zcash_mining_guide.html)
* [Known Issues](https://zcash.readthedocs.io/en/latest/rtd_pages/security_warnings.html)
* [Data Directory Files](https://zcash.readthedocs.io/en/latest/rtd_pages/files.html)
* [Tor Support in zcashd](https://zcash.readthedocs.io/en/latest/rtd_pages/tor.html)
* [Zcash.conf guide](zcash_conf_guide.html)
* [Troubleshooting Guide](troubleshooting_guide.html)
* [Wallet Backup Instructions](wallet_backup.html)
* [Sending Memos with Zcashd](memos.html)
* [Zcash Mining guide](zcash_mining_guide.html)
* [Known Issues](security_warnings.html)
* [Data Directory Files](files.html)
* [Tor Support in zcashd](tor.html)

0 comments on commit 98c2eb4

Please sign in to comment.