Skip to content

Commit

Permalink
Removing all the vuepress related build files and references (#253)
Browse files Browse the repository at this point in the history
* Removing all the vuepress related build files and references (#249)

* Moved documentation ADR to deprecated (#249)

* Reverting the logic for check-docs-toc until ADR/RFC refactor (#249)

* Setting the right permissions to file so workflow executes (#249)

* Reverting ADR change, will do in another issue (#249)

(cherry picked from commit d159562)

# Conflicts:
#	RELEASES.md
#	docs/.vuepress/config.js
#	docs/.vuepress/redirects
#	docs/DOCS_README.md
#	docs/package.json
#	docs/versions
  • Loading branch information
andynog authored and mergify[bot] committed Feb 2, 2023
1 parent 448aaca commit a9aed0b
Show file tree
Hide file tree
Showing 10 changed files with 12 additions and 25,556 deletions.
36 changes: 1 addition & 35 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -280,45 +280,11 @@ vulncheck:

DESTINATION = ./index.html.md


###############################################################################
### Documentation ###
###############################################################################

DOCS_OUTPUT?=/tmp/cometbft-core-docs

# This builds a docs site for each branch/tag in `./docs/versions` and copies
# each site to a version prefixed path. The last entry inside the `versions`
# file will be the default root index.html. Only redirects that are built into
# the "redirects" folder of each of the branches will be copied out to the root
# of the build at the end.
build-docs:
@cd docs && \
while read -r branch path_prefix; do \
(git checkout $${branch} && npm ci && VUEPRESS_BASE="/$${path_prefix}/" npm run build) ; \
mkdir -p $(DOCS_OUTPUT)/$${path_prefix} ; \
cp -r .vuepress/dist/* $(DOCS_OUTPUT)/$${path_prefix}/ ; \
cp $(DOCS_OUTPUT)/$${path_prefix}/index.html $(DOCS_OUTPUT) ; \
cp $(DOCS_OUTPUT)/$${path_prefix}/404.html $(DOCS_OUTPUT) ; \
cp -r $(DOCS_OUTPUT)/$${path_prefix}/redirects/* $(DOCS_OUTPUT) || true ; \
done < versions ;
.PHONY: build-docs

# Build and serve the local version of the docs on the current branch from
# http://0.0.0.0:8080
serve-docs:
@cd docs && \
npm ci && \
npm run serve
.PHONY: serve-docs

sync-docs:
cd ~/output && \
echo "role_arn = ${DEPLOYMENT_ROLE_ARN}" >> /root/.aws/config ; \
echo "CI job = ${CIRCLE_BUILD_URL}" >> version.html ; \
aws s3 sync . s3://${WEBSITE_BUCKET} --profile terraform --delete ; \
aws cloudfront create-invalidation --distribution-id ${CF_DISTRIBUTION_ID} --profile terraform --path "/*" ;
.PHONY: sync-docs

# Verify that important design docs have ToC entries.
check-docs-toc:
@./docs/presubmit.sh
Expand Down
3 changes: 3 additions & 0 deletions RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,7 @@ Before performing these steps, be sure the
- `git tag -a v0.38.0 -m 'Release v0.38.0'`
- `git push origin v0.38.0`
6. Make sure that `main` is updated with the latest `CHANGELOG.md`, `CHANGELOG_PENDING.md`, and `UPGRADING.md`.
<<<<<<< HEAD
7. Add the release to the documentation site generator config (see
[DOCS\_README.md](./docs/DOCS_README.md) for more details). In summary:
- Start on branch `main`.
Expand All @@ -215,6 +216,8 @@ Before performing these steps, be sure the
release in the dropdown versions menu.
- Commit these changes to `main` and backport them into the backport
branch for this release.
=======
>>>>>>> d159562d0 (Removing all the vuepress related build files and references (#253))
## Patch release

Expand Down
9 changes: 0 additions & 9 deletions docs/.textlintrc.json

This file was deleted.

3 changes: 0 additions & 3 deletions docs/.vuepress/styles/index.styl

This file was deleted.

13 changes: 7 additions & 6 deletions docs/DOCS_README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,13 @@ The documentation for Tendermint Core is hosted at:

- <https://docs.tendermint.com>

built from the files in this (`/docs`) directory.
built from the files in these (`/docs` and `/spec`) directories.

## How It Works
Content modified and merged to these folders will be deployed to the `https://docs.cometbft.com` website using workflow logic from the [cometbft-docs](https://github.com/cometbft/cometbft-docs) repository

There is a [GitHub Action](../.github/workflows/docs-deployment.yml) that is
triggered by changes in the `/docs` directory on `main` as well as the branch of
each major supported version (e.g. `v0.34.x`). Any updates to files in this
directory on those branches will automatically trigger a website deployment.
### Building locally

<<<<<<< HEAD
## README

The [README.md](./README.md) is also the landing page for the documentation on
Expand Down Expand Up @@ -100,3 +98,6 @@ Because the build processes are identical (as is the information contained
herein), this file should be kept in sync as much as possible with its
[counterpart in the Cosmos SDK
repo](https://github.com/cosmos/cosmos-sdk/blob/main/docs/README.md).
=======
For information on how to build the documentation and view it locally, please visit the [cometbft-docs](https://github.com/cometbft/cometbft-docs) Github repository.
>>>>>>> d159562d0 (Removing all the vuepress related build files and references (#253))
3 changes: 1 addition & 2 deletions docs/architecture/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,6 @@ Note the context/background should be written in the present tense.

- [ADR-006: Trust-Metric](./adr-006-trust-metric.md)
- [ADR-024: Sign-Bytes](./adr-024-sign-bytes.md)
- [ADR-035: Documentation](./adr-035-documentation.md)
- [ADR-039: Peer-Behaviour](./adr-039-peer-behaviour.md)
- [ADR-063: Privval-gRPC](./adr-063-privval-grpc.md)
- [ADR-067: Mempool Refactor](./adr-067-mempool-refactor.md)
Expand All @@ -84,7 +83,7 @@ Note the context/background should be written in the present tense.

### Deprecated

None
- [ADR-035: Documentation](./adr-035-documentation.md)

### Rejected

Expand Down
Loading

0 comments on commit a9aed0b

Please sign in to comment.