Update workflow to build recipes page

couchbaselabs · Sep 2, 2024 · d1bc805 · d1bc805
1 parent 93813f9
commit d1bc805
Show file tree

Hide file tree

Showing 9 changed files with 20 additions and 2,143 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -9,11 +9,16 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v2
-      - name: Get build container
-        id: adocbuild
+      - name: Build index page
+        id: adocbuild_index
         uses: tonynv/asciidoctor-action@master
         with:
           program: "asciidoctor -D docs -r ./docs/lib/cb-docinfoprocessor.rb -a toc=left -a toclevels=4 -a source-highlighter=coderay -a stylesheet=couchbase.css -a linkcss=true docs/index.adoc"
+      - name: Build recipes page
+        id: adocbuild_recipe
+        uses: tonynv/asciidoctor-action@master
+        with:
+          program: "asciidoctor -D docs -r ./docs/lib/cb-docinfoprocessor.rb -a toc=left -a toclevels=4 -a source-highlighter=coderay -a stylesheet=couchbase.css -a linkcss=true docs/recipes.adoc"
       - name: Print execution time
         run: echo "Time ${{ steps.adocbuild.outputs.time }}"
       - name: Deploy docs to ghpages

diff --git a/docs/recipes/exporting-data.adoc → docs/exporting-data.adoc b/docs/recipes/exporting-data.adoc → docs/exporting-data.adoc
diff --git a/docs/recipes/faking-data.adoc → docs/faking-data.adoc b/docs/recipes/faking-data.adoc → docs/faking-data.adoc
diff --git a/docs/recipes/importing-data.adoc → docs/importing-data.adoc b/docs/recipes/importing-data.adoc → docs/importing-data.adoc
diff --git a/docs/index.adoc b/docs/index.adoc
@@ -23,6 +23,8 @@ include::commands.adoc[]
 
 include::reference.adoc[]
 
-include::recipes.adoc[]
+include::importing-data.adoc[]
+
+include::exporting-data.adoc[]
 
 include::release_notes.adoc[]
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/recipes.adoc b/docs/recipes.adoc
@@ -1,9 +1,10 @@
-== Recipes
+= Recipes
 
-include::recipes/importing-data.adoc[]
+:sectnums:
 
-include::recipes/exporting-data.adoc[]
+Welcome to the recipes section of the Couchbase Shell `cbsh` documentation.
+Here you can find some examples of the more complicated tasks that can be performed using `cbsh`.
 
-include::recipes/useful-snippets.adoc[]
+include::recipes/similarity_search.adoc[]
 
-include::recipes/similarity_search.adoc[]
+include::recipes/useful-snippets.adoc[]
diff --git a/docs/recipes/similarity_search.adoc b/docs/recipes/similarity_search.adoc
@@ -1,4 +1,4 @@
-=== Similarity Search
+== Similarity Search
 
 The <<_vector_commands, vector commands>> can be used to enrich your existing data and allow you to experiment with the value that similarity search can add.
 Before you can follow this recipe you'll need to <<_cb_env_llm,configure a llm>> for use with the shell.

diff --git a/docs/recipes/useful-snippets.adoc b/docs/recipes/useful-snippets.adoc
@@ -1,8 +1,8 @@
-=== Useful snippets
+== Useful snippets
 
 This section contains a collection of useful commands and sets of commands which don't really fit into their own section of recipes.
 
-==== Migrating scope and collection definitions
+=== Migrating scope and collection definitions
 
 When you create a new cluster it can be useful to migrate scope and collection definitions from an old cluster.
 A good example here is migrating from an on-premise cluster to a Capella cluster.
@@ -22,7 +22,7 @@ collections --clusters "On-Prem-Cluster" --bucket "travel-sample" | select scope
 These examples can easily be extended to filter out any other scopes and collections you do not want to migrate.
 For example to filter more scopes you would just add more `where` clauses: `... | where scope != "_default" | where scope != "inventory" | ...`
 
-==== Migrating query index definitions
+=== Migrating query index definitions
 
 When you create a new cluster it can be useful to migrate index definitions from an old cluster.
 A good example here is migrating from an on-premise cluster to a Capella cluster.