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.

Sign up for GitHub

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

Jump to bottom

Remove the .vuepress folder and logic to build the docs #249

Closed
Tracked by #93
andynog opened this issue Jan 31, 2023 · 0 comments · Fixed by #253
Closed
Tracked by #93

Remove the .vuepress folder and logic to build the docs #249

andynog opened this issue Jan 31, 2023 · 0 comments · Fixed by #253
Assignees
@andynog
Labels
documentation Improvements or additions to documentation rename Renaming our fork
Milestone
2023-Q1

Comments

@andynog
Copy link
Contributor

andynog commented Jan 31, 2023 •
edited
Loading

Since we are switching the documentation to build using Jekyll and the logic is in the cometbft-docs repository, it's better to remove all the logic to build the documentation using vuepress. For that we need to:

  • Remove the .vuepress folder
  • Update the content of /docs/DOCS_README.md to point to cometbft-docs repo for instructions on how to build the documentation locally
  • Remove the build-docs from the Makefile
  • Remove:
    docs/package.json
    docs/package-lock.json
    docs/post.sh
    docs/pre.sh
    docs/presubmit.sh
    docs/stop-words.txt
    docs/versions
@andynog andynog added documentation Improvements or additions to documentation rename Renaming our fork labels Jan 31, 2023
@andynog andynog self-assigned this Jan 31, 2023
@andynog andynog changed the title Remove the vue press folder and logic to build the docs from this repo Remove the .vuepress folder and logic to build the docs Jan 31, 2023
This was referenced Jan 31, 2023
Closed
Merged
Merged
andynog added a commit that referenced this issue Feb 1, 2023
@andynog
Removing all the vuepress related build files and references (#249)
a492ea2
@andynog andynog mentioned this issue Feb 1, 2023
Merged
3 tasks
andynog added a commit that referenced this issue Feb 1, 2023
@andynog
Moved documentation ADR to deprecated (#249)
a1283d4
andynog added a commit that referenced this issue Feb 1, 2023
@andynog
Reverting the logic for check-docs-toc until ADR/RFC refactor (#249)
ec23b3a
andynog added a commit that referenced this issue Feb 1, 2023
@andynog
Setting the right permissions to file so workflow executes (#249)
31a5124
andynog added a commit that referenced this issue Feb 1, 2023
@andynog
Reverting ADR change, will do in another issue (#249)
74f9228
andynog added a commit that referenced this issue Feb 2, 2023
@andynog
Removing all the vuepress related build files and references (#253)
d159562 
* 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)
mergify bot pushed a commit that referenced this issue Feb 2, 2023
@andynog @mergify
Removing all the vuepress related build files and references (#253)
a9aed0b 
* 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
mergify bot pushed a commit that referenced this issue Feb 2, 2023
@andynog @mergify
Removing all the vuepress related build files and references (#253)
1087990 
* 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:
#	Makefile
#	RELEASES.md
#	docs/.vuepress/config.js
#	docs/.vuepress/redirects
#	docs/DOCS_README.md
#	docs/architecture/README.md
#	docs/package.json
#	docs/versions
cason pushed a commit that referenced this issue Feb 7, 2023
@andynog @mergify
Removing all the vuepress related build files and references (#253)
5991b06 
* 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
andynog added a commit that referenced this issue Feb 8, 2023
@mergify @andynog @cason
v0.37.x: Removing all the vuepress related build files and references…
286121d 
… (backport #253) (#263)

* Removing all the vuepress related build files and references  (#253)

* 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

* fix for merge

* fixing to merge

---------

Co-authored-by: Andy Nogueira <me@andynogueira.dev>
Co-authored-by: Daniel Cason <daniel.cason@informal.systems>
andynog added a commit that referenced this issue Feb 9, 2023
@mergify @andynog
v0.34.x: Removing all the vuepress related build files and references…
892516a 
… (backport #253) (#264)

* Removing all the vuepress related build files and references  (#253)

* 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:
#	Makefile
#	RELEASES.md
#	docs/.vuepress/config.js
#	docs/.vuepress/redirects
#	docs/DOCS_README.md
#	docs/architecture/README.md
#	docs/package.json
#	docs/versions

* fixing conflicts (#264)

* remove comment leftover from git conflict resolution (#264)

---------

Co-authored-by: Andy Nogueira <me@andynogueira.dev>
@thanethomson thanethomson added this to the 2023-Q1 milestone Feb 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@andynog andynog

Labels
documentation Improvements or additions to documentation rename Renaming our fork
Projects
No open projects
CometBFT 2023
Status: Done
Milestone
2023-Q1
Development

Successfully merging a pull request may close this issue.

Removing all the vuepress related build files and references cometbft/cometbft
2 participants
@thanethomson @andynog