Move main repo to a submodule to enable live editing (#214)

Signed-off-by: Janos Bonic <[email protected]>

.github/workflows/deploy-dev.yml

@@ -16,6 +16,8 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v3
+        with:
+          submodules: 'true'
       - name: Setup Node
         uses: actions/setup-node@v3
         with:
@@ -24,8 +26,6 @@ jobs:
         run: npm ci
       - name: Lint code
         run: npm run lint
-      - name: Fetch docs
-        run: make
       - name: Build website
         run: npm run build
       - name: Publish to Cloudflare Pages

.github/workflows/deploy-prod.yml

@@ -25,6 +25,8 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v3
+        with:
+          submodules: 'true'
       - name: Setup Node
         uses: actions/setup-node@v3
         with:
@@ -33,8 +35,6 @@ jobs:
         run: npm ci
       - name: Lint code
         run: npm run lint
-      - name: Fetch docs
-        run: make
       - name: Build website
         run: npm run build
       - name: Setup Pages

.gitignore

@@ -15,11 +15,8 @@
 .env.test.local
 .env.production.local
 .eslintcache
+.idea
 
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
-
-/opentofu-repo
-/docs/**
-!/docs/index.mdx

.gitmodules

@@ -0,0 +1,4 @@
+[submodule "opentofu-repo"]
+	path = opentofu-repo
+	url = https://github.com/opentofu/opentofu
+	branch = main

README.md

@@ -25,7 +25,8 @@ npm i
 3. Fetch the documentation
 
 ```bash
-make
+git submodule init
+git submodule update
 ```
 
 4. Start the development server

docusaurus.config.js

@@ -100,12 +100,13 @@ const config = {
         },
         docs: {
           sidebarPath: require.resolve("./sidebars.js"),
+          path: "opentofu-repo/website/docs",
           routeBasePath: "/docs",
           editUrl: ({ docPath }) => {
             // Remove the edit link from the documentation index page
             // TODO: remove after moving the page to the main OpenTofu repo
             if (docPath === "index.mdx") {
-              return undefined;
+              return `https://github.com/opentofu/opentofu.org/edit/main/docs/${docPath}`;
             }
 
             return `https://github.com/opentofu/opentofu/edit/main/website/docs/${docPath}`;