Merge pull request #6858

49a279b docs: Add release checklist (setsimmo)
d00ca88 Move documentation files to their own directory (glv2)

README.md

@@ -111,7 +111,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
 
@@ -648,11 +648,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

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

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