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

Restore documentation that had been moved to zcash.readthedocs.io #5953

Merged
merged 7 commits into from Sep 1, 2022

Conversation

nuttycom
Copy link
Contributor

This reverts 70ebc09 which
had previously moved zcashd documentation to zcash.readthedocs.io, backports changes that had
been made on the readthedocs site, and moves the update documentation into the zcashd book.

doc/dnsseed-policy.md Outdated Show resolved Hide resolved
doc/wallet-backup.md Outdated Show resolved Hide resolved
doc/tor.md Outdated Show resolved Hide resolved
@str4d str4d added the A-documentation Area: Documentation label May 12, 2022
@mdr0id
Copy link
Contributor

mdr0id commented May 13, 2022

I'm not quite sure I understand this PR. Are we now going to support 2 sets of user style guides in read the docs and in this repo again?

@skyl
Copy link

skyl commented May 13, 2022

I'm not quite sure I understand this PR. Are we now going to support 2 sets of user style guides in read the docs and in this repo again?

Would it make sense to deprecate the RTD repo and just push the RTD site as an artifact from here? I was looking to get started on zcash/zcash today to look at the speed of the tests and I got sidetracked looking for the RTD source to fix a few small things there (it says 4.6.0 and says rpc-tests.sh instead of rpc-tests.py, for example). If the RTD source was in this repo, it would have been a better experience.

@nuttycom
Copy link
Contributor Author

nuttycom commented Aug 10, 2022

I'm not quite sure I understand this PR. Are we now going to support 2 sets of user style guides in read the docs and in this repo again?

The intent would be for everything that is specifically zcashd related to be removed from the readthedocs site, and for it to point to the zcashd book for zcashd-specific documentation. It's too easy for the readthedocs site to bitrot; by moving the zcashd-related content here we can ensure it's updated when a pull request changes things that are mentioned in the docs.

nuttycom and others added 5 commits August 25, 2022 10:29
This is an separate from the other backporting because this was an upstream
document, so isolating it helps with future backports from upstream.
@nuttycom nuttycom requested a review from str4d August 25, 2022 17:16
@nuttycom nuttycom added the safe-to-build Used to send PR to prod CI environment label Aug 25, 2022
@ECC-CI ECC-CI removed the safe-to-build Used to send PR to prod CI environment label Aug 25, 2022
doc/files.md Outdated Show resolved Hide resolved
`zcash-cli z_importwallet <path/to/exportdir/nameofbackup>`
```bash
$ zcash-cli z_importwallet <path/to/exportdir/nameofbackup>
```

Copy link
Contributor

@daira daira Aug 30, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs work. HD-generated keys won't be included in the export file and therefore won't be imported; this includes all Sapling and Orchard keys generated since and including zcashd 4.7.0.

`zcash-cli help importprivkey`
```bash
$ zcash-cli help importprivkey
```

### Using `dumpwallet`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is currently disabled by default.

doc/tor.md Outdated
```

Note that zcashd does not yet support Onion v3 addresses, but will do so before
v2 addresses are removed from Tor. See [this
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nope.

daira
daira previously approved these changes Aug 30, 2022
Copy link
Contributor

@daira daira left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK with comments.

doc/book/src/user/files.md Outdated Show resolved Hide resolved
Copy link
Contributor

@daira daira left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK

@daira daira added the safe-to-build Used to send PR to prod CI environment label Aug 30, 2022
@ECC-CI ECC-CI removed the safe-to-build Used to send PR to prod CI environment label Aug 30, 2022
@sellout sellout added the safe-to-build Used to send PR to prod CI environment label Aug 30, 2022
@sellout sellout removed the safe-to-build Used to send PR to prod CI environment label Aug 30, 2022
Copy link
Contributor

@str4d str4d left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK. There is more we should do with these, but we can do that in subsequent PRs once we've seen how it fits into the book.

@nuttycom nuttycom merged commit 294d967 into zcash:master Sep 1, 2022
@nuttycom nuttycom deleted the doc/reclaim_gitlab_docs branch September 1, 2022 15:42
@str4d str4d added this to the Release 5.3.0 milestone Sep 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-documentation Area: Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants