docs: Docusaurus Migration (#2906)

* Removed vuepress, add base docusaurus includes * Updated Docusarus files, without the deployment * Fix the footer * Added test deployment * Update deploy-docusaurus.yml * Update docs.yml Disable the old docs workflow * Update deploy-docusaurus.yml * Updated deployment scripts, aligning with ICS * Added deployment script * Removed redundent github workflows * Fix broken tables in governance section * Table -> KeyValueTable; linkify keys * Fix KeyValueTable references; fix code baseline alignment * Add community menu to header * Forum -> Cosmos Forums * Update icon to Cosmos Forums * various updates * Updates to page formatting * Updates to formatting * various changes * Updated base url * Swap algolia keys and swap ICS and Translations sections * Updated ICS section * Added max validators var * Mava integration trial * Update nightly-tests.yml * Update nightly-tests.yml * Update nightly-tests.yml * Removed outdated translations * Removed test mava page, mava currently unavailable * Updated styles, to show missing or hidden items * Added versioning * Fix some nits, update deps and move some docs to new folders * Remove unneeded file * Revert merge mangle in nightly tests * Fix broken links and update docusaurus config --------- Co-authored-by: Aaron Wright <[email protected]>
cosmos · Feb 8, 2024 · 4131243 · 4131243
1 parent 2a8a4b0
commit 4131243
Show file tree

Hide file tree

Showing 295 changed files with 9,885 additions and 30,033 deletions.
diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml
@@ -0,0 +1,47 @@
+name: Deploy docs
+# This job builds and deploys documenation to github pages.
+# It runs on every push to main with a change in the docs folder.
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+      # - "release/**"
+    paths:
+      - "docs/**"
+      # - "x/**/*.md"
+      - .github/workflows/deploy-docs.yml
+
+permissions:
+  contents: read
+
+jobs:
+  build-and-deploy:
+    permissions:
+      contents: write # for JamesIves/github-pages-deploy-action to push changes in repo
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout 🛎️
+        uses: actions/checkout@v3
+        with:
+          persist-credentials: false
+          fetch-depth: 0
+          path: "."
+
+      - name: Setup Node.js 🔧
+        uses: actions/setup-node@v3
+        with:
+          node-version: "16.x"
+
+      # npm install npm should be removed when https://github.com/npm/cli/issues/4942 is fixed
+      - name: Build 🔧
+        run: |
+          npm install -g [email protected]
+          make build-docs
+
+      - name: Deploy 🚀
+        uses: JamesIves/[email protected]
+        with:
+          branch: gh-pages
+          folder: ~/output
+          single-commit: true
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
diff --git a/.github/workflows/nightly-tests.yml b/.github/workflows/nightly-tests.yml
@@ -60,4 +60,4 @@ jobs:
                   }
                 }
               ]
-            }
+            }
diff --git a/Makefile b/Makefile
@@ -173,26 +173,13 @@ else
 endif
 
 ###############################################################################
-###                                 Devdoc                                  ###
+###                              Documentation                              ###
 ###############################################################################
 
 build-docs:
-	@cd docs && \
-	while read p; do \
-		(git checkout $${p} && npm install && VUEPRESS_BASE="/$${p}/" npm run build) ; \
-		mkdir -p ~/output/$${p} ; \
-		cp -r .vuepress/dist/* ~/output/$${p}/ ; \
-		cp ~/output/$${p}/index.html ~/output ; \
-	done < versions ;
-.PHONY: build-docs
+	@cd docs && ./build.sh
 
-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
+.PHONY: build-docs
 
 
 ###############################################################################

diff --git a/docs/.gitignore b/docs/.gitignore
@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
diff --git a/docs/.vuepress/components/home.vue b/docs/.vuepress/components/home.vue
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
-Original file line number
+Diff line change
@@ Expand Up / @@ -60,4 +60,4 @@ jobs: @@
                       }
                     }
                   ]
-                }
+                }