From 525d6ca389eda89d0b81131be8311d8f8ad1d8ed Mon Sep 17 00:00:00 2001 From: Callum Waters Date: Tue, 15 Feb 2022 11:16:47 +0100 Subject: [PATCH] disable markdown link checker and migrate spec RFCs --- .github/workflows/action.yml | 17 ----------------- .github/workflows/markdown-links.yml | 18 ++++++++++++++++++ Makefile | 2 +- .../adr-077-block-retention.md} | 6 +++--- .../adr-078-nonzero-genesis.md} | 4 ++-- .../adr-079-ed25519-verification.md} | 2 +- .../adr-080-reverse-sync.md} | 4 ++-- .../img}/block-retention.png | Bin .../{rfc-014-abci++.md => rfc-011-abci++.md} | 2 +- ...ning.md => rfc-012-semantic-versioning.md} | 2 +- 10 files changed, 29 insertions(+), 28 deletions(-) delete mode 100644 .github/workflows/action.yml create mode 100644 .github/workflows/markdown-links.yml rename docs/{rfc/rfc-011-block-retention.md => architecture/adr-077-block-retention.md} (96%) rename docs/{rfc/rfc-012-nonzero-genesis.md => architecture/adr-078-nonzero-genesis.md} (96%) rename docs/{rfc/rfc-013-ed25519-verification.md => architecture/adr-079-ed25519-verification.md} (98%) rename docs/{rfc/rfc-015-reverse-sync.md => architecture/adr-080-reverse-sync.md} (97%) rename docs/{rfc/images => architecture/img}/block-retention.png (100%) rename docs/rfc/{rfc-014-abci++.md => rfc-011-abci++.md} (99%) rename docs/rfc/{rfc-016-semantic-versioning.md => rfc-012-semantic-versioning.md} (99%) diff --git a/.github/workflows/action.yml b/.github/workflows/action.yml deleted file mode 100644 index 3cb9cb31b..000000000 --- a/.github/workflows/action.yml +++ /dev/null @@ -1,17 +0,0 @@ -name: Check Markdown links - -on: - push: - branches: - - master - pull_request: - branches: [master] - -jobs: - markdown-link-check: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@master - - uses: gaurav-nelson/github-action-markdown-link-check@1.0.13 - with: - check-modified-files-only: 'yes' diff --git a/.github/workflows/markdown-links.yml b/.github/workflows/markdown-links.yml new file mode 100644 index 000000000..0c0e7525a --- /dev/null +++ b/.github/workflows/markdown-links.yml @@ -0,0 +1,18 @@ +# Currently disabled until all links have been fixed +# name: Check Markdown links + +# on: +# push: +# branches: +# - master +# pull_request: +# branches: [master] + +# jobs: +# markdown-link-check: +# runs-on: ubuntu-latest +# steps: +# - uses: actions/checkout@master +# - uses: gaurav-nelson/github-action-markdown-link-check@1.0.13 +# with: +# check-modified-files-only: 'yes' diff --git a/Makefile b/Makefile index 42a0d45d7..0fd996c67 100644 --- a/Makefile +++ b/Makefile @@ -78,7 +78,7 @@ $(BUILDDIR)/: # there and run the Build & Push Proto Builder Image workflow. IMAGE := ghcr.io/tendermint/docker-build-proto:latest DOCKER_PROTO_BUILDER := docker run -v $(shell pwd):/workspace --workdir /workspace $(IMAGE) -HTTPS_GIT := https://github.com/tendermint/spec.git +HTTPS_GIT := https://github.com/tendermint/tendermint.git ############################################################################### ### Protobuf ### diff --git a/docs/rfc/rfc-011-block-retention.md b/docs/architecture/adr-077-block-retention.md similarity index 96% rename from docs/rfc/rfc-011-block-retention.md rename to docs/architecture/adr-077-block-retention.md index 8bfc0021e..714b4810a 100644 --- a/docs/rfc/rfc-011-block-retention.md +++ b/docs/architecture/adr-077-block-retention.md @@ -1,4 +1,4 @@ -# RFC 011: Configurable Block Retention +# ADR 077: Configurable Block Retention ## Changelog @@ -6,7 +6,7 @@ - 2020-03-25: Use local config for snapshot interval (@erikgrinaker) - 2020-03-31: Use ABCI commit response for block retention hint - 2020-04-02: Resolved open questions -- 2021-02-11: Migrate RFC to tendermint repo (Originally [RFC 001](https://github.com/tendermint/spec/pull/84)) +- 2021-02-11: Migrate to tendermint repo (Originally [RFC 001](https://github.com/tendermint/spec/pull/84)) ## Author(s) @@ -74,7 +74,7 @@ The returned `retain_height` would be the lowest height that satisfies: - Local config: archive nodes may want to retain more or all blocks, e.g. via a local config option `min-retain-blocks`. There may also be a need to vary rentention for other nodes, e.g. sentry nodes which do not need historical blocks. -![Cosmos SDK block retention diagram](images/block-retention.png) +![Cosmos SDK block retention diagram](img/block-retention.png) ## Status diff --git a/docs/rfc/rfc-012-nonzero-genesis.md b/docs/architecture/adr-078-nonzero-genesis.md similarity index 96% rename from docs/rfc/rfc-012-nonzero-genesis.md rename to docs/architecture/adr-078-nonzero-genesis.md index fb9b0afda..8fdc1e61a 100644 --- a/docs/rfc/rfc-012-nonzero-genesis.md +++ b/docs/architecture/adr-078-nonzero-genesis.md @@ -1,4 +1,4 @@ -# RFC 012: Non-Zero Genesis +# ADR 078: Non-Zero Genesis ## Changelog @@ -6,7 +6,7 @@ - 2020-07-28: Use weak chain linking, i.e. `predecessor` field (@erikgrinaker) - 2020-07-31: Drop chain linking (@erikgrinaker) - 2020-08-03: Add `State.InitialHeight` (@erikgrinaker) -- 2021-02-11: Migrate RFC to tendermint repo (Originally [RFC 002](https://github.com/tendermint/spec/pull/119)) +- 2021-02-11: Migrate to tendermint repo (Originally [RFC 002](https://github.com/tendermint/spec/pull/119)) ## Author(s) diff --git a/docs/rfc/rfc-013-ed25519-verification.md b/docs/architecture/adr-079-ed25519-verification.md similarity index 98% rename from docs/rfc/rfc-013-ed25519-verification.md rename to docs/architecture/adr-079-ed25519-verification.md index 64efd6c11..c20869e6c 100644 --- a/docs/rfc/rfc-013-ed25519-verification.md +++ b/docs/architecture/adr-079-ed25519-verification.md @@ -1,4 +1,4 @@ -# RFC 013: Ed25519 Verification +# ADR 079: Ed25519 Verification ## Changelog diff --git a/docs/rfc/rfc-015-reverse-sync.md b/docs/architecture/adr-080-reverse-sync.md similarity index 97% rename from docs/rfc/rfc-015-reverse-sync.md rename to docs/architecture/adr-080-reverse-sync.md index 115b64813..50604ecee 100644 --- a/docs/rfc/rfc-015-reverse-sync.md +++ b/docs/architecture/adr-080-reverse-sync.md @@ -1,8 +1,8 @@ -# RFC 015: ReverseSync - fetching historical data +# ADR 080: ReverseSync - fetching historical data ## Changelog -- 2021-02-11: Migrate RFC to tendermint repo (Originally [RFC 005](https://github.com/tendermint/spec/pull/224)) +- 2021-02-11: Migrate to tendermint repo (Originally [RFC 005](https://github.com/tendermint/spec/pull/224)) - 2021-04-19: Use P2P to gossip necessary data for reverse sync. - 2021-03-03: Simplify proposal to the state sync case. - 2021-02-17: Add notes on asynchronicity of processes. diff --git a/docs/rfc/images/block-retention.png b/docs/architecture/img/block-retention.png similarity index 100% rename from docs/rfc/images/block-retention.png rename to docs/architecture/img/block-retention.png diff --git a/docs/rfc/rfc-014-abci++.md b/docs/rfc/rfc-011-abci++.md similarity index 99% rename from docs/rfc/rfc-014-abci++.md rename to docs/rfc/rfc-011-abci++.md index de723d28e..96faa43c5 100644 --- a/docs/rfc/rfc-014-abci++.md +++ b/docs/rfc/rfc-011-abci++.md @@ -1,4 +1,4 @@ -# RFC 014: ABCI++ +# RFC 011: ABCI++ ## Changelog diff --git a/docs/rfc/rfc-016-semantic-versioning.md b/docs/rfc/rfc-012-semantic-versioning.md similarity index 99% rename from docs/rfc/rfc-016-semantic-versioning.md rename to docs/rfc/rfc-012-semantic-versioning.md index bc04aee2c..f206caf44 100644 --- a/docs/rfc/rfc-016-semantic-versioning.md +++ b/docs/rfc/rfc-012-semantic-versioning.md @@ -1,4 +1,4 @@ -# RFC 006: Semantic Versioning +# RFC 012: Semantic Versioning ## Changelog