Future Documentation workflow

.github/workflows/modular-docs-publish.yml

@@ -1,10 +1,16 @@
 # This workflow will generate modular docs and publish to the modular-docs branch
 
-name: Modular docs publish
+name: Downstream docs publish
 
+# on:
+#   push:
+#     tags:
+#       - 'v*'
+
+## For testing
 on:
   push:
-    branches: [ main ]
+    branches: [ adoc-modular ]
 
 jobs:
   build:
@@ -16,10 +22,10 @@ jobs:
         uses: actions/setup-go@v2
         with:
           go-version: 1.16.x
-      - run: make generate-modular-docs
-        name: Generate modular-docs
+      - run: make generate-downstream-docs
+        name: Generate generate-downstream-docs
       - name: Deploy
         uses: JamesIves/github-pages-deploy-action@4.1.9
         with:
-          branch: modular-docs # The branch the action should deploy to.
+          branch: downstream-docs # The branch the action should deploy to.
           folder: dist # The folder the action should deploy.

.vscode/launch.json

@@ -268,5 +268,18 @@
         "--yes"
       ]
     },
+    {
+      "name": "Docs",
+      "type": "go",
+      "request": "launch",
+      "mode": "auto",
+      "program": "${workspaceFolder}/cmd/rhoas",
+      "env": {},
+      "args": [
+        "docs",
+        "--file-format", "adoc",
+        "--dir", "./docs/commands"
+      ]
+    },
   ]
 }

Makefile

@@ -85,12 +85,13 @@ check-docs: generate-docs ## Check whether reference documentation needs to be g
 
 generate-docs: ## Generate command-line reference documentation
 	rm -rf ./docs/commands/*
-	go run ./cmd/rhoas docs --dir ./docs/commands --file-format adoc
+	go run ./cmd/rhoas docs --dir ./docs/commands --file-format md
 .PHONY: generate-docs
 
-generate-modular-docs: generate-docs ## Generate modular command-line reference documentation
-	SRC_DIR=$$(pwd)/docs/commands DEST_DIR=$$(pwd)/dist go run ./cmd/modular-docs
-.PHONY: generate-modular-docs
+generate-downstream-docs: ## Generate command-line reference documentation in adoc format
+	rm -rf ./docs/commands/*
+	go run ./cmd/rhoas docs --dir ./dist --file-format adoc
+.PHONY: generate-downstream-docs
 
 lint-lang: ## Lint i18n files
 	go install github.com/redhat-developer/app-services-go-linter/cmd/app-services-go-linter@latest