From d00ca885bce657e536751f19bdb768e48f9d9215 Mon Sep 17 00:00:00 2001 From: Guillaume Le Vaillant <glv@posteo.net> Date: Sat, 3 Oct 2020 08:59:54 +0200 Subject: [PATCH 1/2] Move documentation files to their own directory --- README.md | 6 +++--- ANONYMITY_NETWORKS.md => docs/ANONYMITY_NETWORKS.md | 0 CONTRIBUTING.md => docs/CONTRIBUTING.md | 0 LEVIN_PROTOCOL.md => docs/LEVIN_PROTOCOL.md | 2 +- README.i18n.md => docs/README.i18n.md | 0 ZMQ.md => docs/ZMQ.md | 0 6 files changed, 4 insertions(+), 4 deletions(-) rename ANONYMITY_NETWORKS.md => docs/ANONYMITY_NETWORKS.md (100%) rename CONTRIBUTING.md => docs/CONTRIBUTING.md (100%) rename LEVIN_PROTOCOL.md => docs/LEVIN_PROTOCOL.md (99%) rename README.i18n.md => docs/README.i18n.md (100%) rename ZMQ.md => docs/ZMQ.md (100%) diff --git a/README.md b/README.md index cd67f8022..ef96a1c25 100644 --- a/README.md +++ b/README.md @@ -113,7 +113,7 @@ See [LICENSE](LICENSE). ## Contributing -If you want to help out, see [CONTRIBUTING](CONTRIBUTING.md) for a set of guidelines. +If you want to help out, see [CONTRIBUTING](docs/CONTRIBUTING.md) for a set of guidelines. ## Scheduled software upgrades @@ -650,11 +650,11 @@ monero-wallet-cli, and possibly monerod, if you get crashes refreshing. ## Internationalization -See [README.i18n.md](README.i18n.md). +See [README.i18n.md](docs/README.i18n.md). ## Using Tor -> There is a new, still experimental, [integration with Tor](ANONYMITY_NETWORKS.md). The +> There is a new, still experimental, [integration with Tor](docs/ANONYMITY_NETWORKS.md). The > feature allows connecting over IPv4 and Tor simultaneously - IPv4 is used for > relaying blocks and relaying transactions received by peers whereas Tor is > used solely for relaying transactions received over local RPC. This provides diff --git a/ANONYMITY_NETWORKS.md b/docs/ANONYMITY_NETWORKS.md similarity index 100% rename from ANONYMITY_NETWORKS.md rename to docs/ANONYMITY_NETWORKS.md diff --git a/CONTRIBUTING.md b/docs/CONTRIBUTING.md similarity index 100% rename from CONTRIBUTING.md rename to docs/CONTRIBUTING.md diff --git a/LEVIN_PROTOCOL.md b/docs/LEVIN_PROTOCOL.md similarity index 99% rename from LEVIN_PROTOCOL.md rename to docs/LEVIN_PROTOCOL.md index 207509146..43500fd06 100644 --- a/LEVIN_PROTOCOL.md +++ b/docs/LEVIN_PROTOCOL.md @@ -10,7 +10,7 @@ extensibility. One of the goals of this document is to clearly indicate what is being sent "on the wire" to identify metadata that could de-anonymize users over I2P/Tor. These issues will be addressed as they are found. See `ANONMITY_NETWORKS.md` in -the top-level folder for any outstanding issues. +the `docs` folder for any outstanding issues. > This document does not currently list all data being sent by the monero > protocol, that portion is a work-in-progress. Please take the time to do it diff --git a/README.i18n.md b/docs/README.i18n.md similarity index 100% rename from README.i18n.md rename to docs/README.i18n.md diff --git a/ZMQ.md b/docs/ZMQ.md similarity index 100% rename from ZMQ.md rename to docs/ZMQ.md From 49a279bdfa5e23951ac9d6342ed07cc621bfd47f Mon Sep 17 00:00:00 2001 From: Seth Simmons <setsimmo@cisco.com> Date: Sat, 3 Oct 2020 09:39:20 +0200 Subject: [PATCH 2/2] docs: Add release checklist --- docs/RELEASE_CHECKLIST.md | 68 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 68 insertions(+) create mode 100644 docs/RELEASE_CHECKLIST.md diff --git a/docs/RELEASE_CHECKLIST.md b/docs/RELEASE_CHECKLIST.md new file mode 100644 index 000000000..632366985 --- /dev/null +++ b/docs/RELEASE_CHECKLIST.md @@ -0,0 +1,68 @@ +- [ ] Security audit +- [ ] Code audit +- [ ] Ledger integration + - [ ] Implemented in Monero codebase (if needed) + - [ ] Ledger app integration coded by Ledger + - [ ] Ledger Monero app update available +- [ ] Trezor integration + - [ ] Implemented in Monero codebase (if needed) + - [ ] Trezor app integration coded by Trezor + - [ ] Trezor firmware update available (if needed) +- [ ] Fork height set + - [ ] Monero-announce mailer notice + - [ ] Twitter announcement + - [ ] Reddit announcement + - [ ] Getmonero.org announcement +- [ ] Notify wallets + - [ ] MyMonero + - [ ] Coinomi + - [ ] Exa Wallet + - [ ] Wookey Wallet + - [ ] X Wallet + - [ ] Guarda + - [ ] ZelCore + - [ ] Cake Wallet + - [ ] Monerujo + - [ ] Edge Wallet + - [ ] Exodus + - [ ] XMRWallet +- [ ] Notify exchanges + - [ ] https://web.getmonero.org/community/merchants/#exchanges +- [ ] Notify 3rd party payment processors + - [ ] https://web.getmonero.org/community/merchants/#payment-gateways +- [ ] Notify mining pools + - [ ] https://miningpoolstats.stream/monero +- [ ] Release tagged + - [ ] Update src/version.cpp.in with new version AND new name (if necessary) + - [ ] Update Gitian YML files in contrib/gitian/ to the new version number + - [ ] Update README.md with new fork table entry (or at least update the Recommended Monero version) + - [ ] Update contrib/gitian/README.md so that the instructions reflect the current version + - [ ] Update src/checkpoints/checkpoints.cpp with a recent hardcoded checkpoint + - [ ] Update src/blocks/checkpoints.dat with ./monero-blockchain-export --output-file checkpoints.dat --block-stop <recent block height> --blocksdat + - [ ] Update expected_block_hashes_hash in src/cryptonote_core/blockchain.cpp with checkpoints.dat sha256 hash +- [ ] Testnet forked +- [ ] Testnet testing/verification + - [ ] Ledger + - [ ] Trezor + - [ ] Release-specific testing + - [ ] RPC testing/update RPC documentation +- [ ] CLI reproducible builds validated +- [ ] CLI released + - [ ] https://web.getmonero.org/downloads/ updated + - [ ] Update hashes.txt on website + - [ ] Update downloads.yml on website + - [ ] Update auto-update DNS records + - [ ] Update redirects on downloads box + - [ ] Update seed nodes +- [ ] GUI released + - [ ] https://web.getmonero.org/downloads/ updated + - [ ] Update hashes.txt on website + - [ ] Update hashes.txt.sig on website + - [ ] Update downloads.yml on website + - [ ] Update auto-update DNS records + - [ ] Update redirects on downloads box +- [ ] Release Announcements + - [ ] Monero-announce mailer notice + - [ ] Twitter announcement + - [ ] Reddit announcement + - [ ] Getmonero.org announcement