DEVAI-25: Move TechDocs From Content To Skeleton (#45)

* remove docs and mkdocs.yaml from template contents Signed-off-by: Jordan Dubrick <jdubrick@redhat.com> * move tekton readme to techdocs dir and remove from script Signed-off-by: Jordan Dubrick <jdubrick@redhat.com> * bump source component readme to techdoc skeleton Signed-off-by: Jordan Dubrick <jdubrick@redhat.com> * add action for techdocs Signed-off-by: Jordan Dubrick <jdubrick@redhat.com> * rework action to contain values Signed-off-by: Jordan Dubrick <jdubrick@redhat.com> * test for ai-lab-app remove this commit Signed-off-by: Jordan Dubrick <jdubrick@redhat.com> * Revert "test for ai-lab-app remove this commit" This reverts commit 8ac1648. * pull in ai lab app change Signed-off-by: Jordan Dubrick <jdubrick@redhat.com> * fix rebase messup and pull in doc changes with generate.sh Signed-off-by: Jordan Dubrick <jdubrick@redhat.com> --------- Signed-off-by: Jordan Dubrick <jdubrick@redhat.com>
redhat-ai-dev · Nov 14, 2024 · d6d6d5b · d6d6d5b
1 parent ce95ee0
commit d6d6d5b
Show file tree

Hide file tree

Showing 63 changed files with 48 additions and 605 deletions.
diff --git a/scripts/import-ai-lab-samples b/scripts/import-ai-lab-samples
@@ -20,8 +20,10 @@ fi
 
 (cd $SAMPLE_DIR; git checkout $BRANCH; git pull)
 
-
 cd $SAMPLE_DIR
+# get readme to source component doc
+cp -r $SAMPLE_DIR/README.md  $SKELETON_DIR/techdoc/docs/source-component.md
+
 for f in */; do
     if [ -d "$f" ]; then
         # $f is a directory
@@ -36,14 +38,7 @@ for f in */; do
         cp -r $ROOT_DIR/skeleton/template-card-techdocs/base/mkdocs.yml $DEST/mkdocs.yml
 
         cp $ROOT_DIR/skeleton/template.yaml $DEST/template.yaml
-
-        cp -r $ROOT_DIR/skeleton/techdoc/docs  $DEST/content/docs
-        cp -r $ROOT_DIR/skeleton/techdoc/mkdocs.yml  $DEST/content/mkdocs.yml
-
-        # get readme to source component doc
-        cp -r $SAMPLE_DIR/README.md  $DEST/content/docs/source-component.md
-        cp -r $ROOT_DIR/skeleton/source-repo/.tekton/README.md  $DEST/content/docs/pipelines.md
-
+
         # get default env variables
         source $SCRIPTDIR/envs/base
 

diff --git a/scripts/update-tekton-definition b/scripts/update-tekton-definition
@@ -36,10 +36,10 @@ SRC_TEKTON=$ROOTDIR/skeleton/source-repo/.tekton
 rm -rf $SRC_TEKTON
 mkdir -p $SRC_TEKTON   
 cp -r $TEMPDIR/$REPONAME/pac/source-repo/. $SRC_TEKTON
-
+cp $SRC_TEKTON/README.md $ROOTDIR/skeleton/techdoc/docs/pipelines.md
 rm -rf $TEMPDIR
 
-for prun in $SRC_TEKTON/*.yaml $GITOPS_TEKTON/*.yaml; do 
+for prun in $SRC_TEKTON/*.yaml; do 
         echo "Labels for $prun" 
         add-backstage-labels $prun
 done 

diff --git a/...s/audio-to-text/content/docs/pipelines.md → skeleton/techdoc/docs/pipelines.md b/...s/audio-to-text/content/docs/pipelines.md → skeleton/techdoc/docs/pipelines.md
diff --git a/...-to-text/content/docs/source-component.md → skeleton/techdoc/docs/source-component.md b/...-to-text/content/docs/source-component.md → skeleton/techdoc/docs/source-component.md
diff --git a/skeleton/template.yaml b/skeleton/template.yaml
@@ -255,6 +255,13 @@ spec:
       input:
         url: ./content
         targetPath: source
+    # Renders all of the template variables into the techdocs and adds them to the source repo
+    - id: fetch-skeleton-docs
+      name: Fetch Skeleton Techdocs
+      action: fetch:template
+      input:
+        url: ../../skeleton/techdoc
+        targetPath: source
         values:
           name: ${{ parameters.name }}
           appSummary: ${APP_SUMMARY}

diff --git a/templates/audio-to-text/content/docs/gitops-application.md b/templates/audio-to-text/content/docs/gitops-application.md
diff --git a/templates/audio-to-text/content/docs/images/access-openshift-ai.png b/templates/audio-to-text/content/docs/images/access-openshift-ai.png
diff --git a/templates/audio-to-text/content/docs/images/access-workbench.png b/templates/audio-to-text/content/docs/images/access-workbench.png
diff --git a/templates/audio-to-text/content/docs/images/data-science-projects.png b/templates/audio-to-text/content/docs/images/data-science-projects.png
diff --git a/templates/audio-to-text/content/docs/images/open-terminal.png b/templates/audio-to-text/content/docs/images/open-terminal.png
diff --git a/templates/audio-to-text/content/docs/images/workbench-name.png b/templates/audio-to-text/content/docs/images/workbench-name.png
diff --git a/templates/audio-to-text/content/docs/index.md b/templates/audio-to-text/content/docs/index.md
diff --git a/templates/audio-to-text/content/docs/rhoai.md b/templates/audio-to-text/content/docs/rhoai.md
diff --git a/templates/audio-to-text/content/mkdocs.yml b/templates/audio-to-text/content/mkdocs.yml
diff --git a/templates/audio-to-text/template.yaml b/templates/audio-to-text/template.yaml
@@ -192,6 +192,13 @@ spec:
       input:
         url: ./content
         targetPath: source
+    # Renders all of the template variables into the techdocs and adds them to the source repo
+    - id: fetch-skeleton-docs
+      name: Fetch Skeleton Techdocs
+      action: fetch:template
+      input:
+        url: ../../skeleton/techdoc
+        targetPath: source
         values:
           name: ${{ parameters.name }}
           appSummary: An AI-enabled audio transcription streamlit application. Upload an audio file to be transcribed.

diff --git a/templates/chatbot/content/docs/gitops-application.md b/templates/chatbot/content/docs/gitops-application.md
diff --git a/templates/chatbot/content/docs/images/access-openshift-ai.png b/templates/chatbot/content/docs/images/access-openshift-ai.png
diff --git a/templates/chatbot/content/docs/images/access-workbench.png b/templates/chatbot/content/docs/images/access-workbench.png
diff --git a/templates/chatbot/content/docs/images/data-science-projects.png b/templates/chatbot/content/docs/images/data-science-projects.png
diff --git a/templates/chatbot/content/docs/images/open-terminal.png b/templates/chatbot/content/docs/images/open-terminal.png
diff --git a/templates/chatbot/content/docs/images/workbench-name.png b/templates/chatbot/content/docs/images/workbench-name.png
diff --git a/templates/chatbot/content/docs/index.md b/templates/chatbot/content/docs/index.md
diff --git a/templates/chatbot/content/docs/pipelines.md b/templates/chatbot/content/docs/pipelines.md
diff --git a/templates/chatbot/content/docs/rhoai.md b/templates/chatbot/content/docs/rhoai.md
diff --git a/templates/chatbot/content/docs/source-component.md b/templates/chatbot/content/docs/source-component.md
diff --git a/templates/chatbot/content/mkdocs.yml b/templates/chatbot/content/mkdocs.yml
diff --git a/templates/chatbot/template.yaml b/templates/chatbot/template.yaml
@@ -215,6 +215,13 @@ spec:
       input:
         url: ./content
         targetPath: source
+    # Renders all of the template variables into the techdocs and adds them to the source repo
+    - id: fetch-skeleton-docs
+      name: Fetch Skeleton Techdocs
+      action: fetch:template
+      input:
+        url: ../../skeleton/techdoc
+        targetPath: source
         values:
           name: ${{ parameters.name }}
           appSummary: A Large Language Model (LLM)-enabled streamlit chat application. The bot replies with AI generated responses.

diff --git a/templates/codegen/content/docs/gitops-application.md b/templates/codegen/content/docs/gitops-application.md
diff --git a/templates/codegen/content/docs/images/access-openshift-ai.png b/templates/codegen/content/docs/images/access-openshift-ai.png
diff --git a/templates/codegen/content/docs/images/access-workbench.png b/templates/codegen/content/docs/images/access-workbench.png
diff --git a/templates/codegen/content/docs/images/data-science-projects.png b/templates/codegen/content/docs/images/data-science-projects.png
diff --git a/templates/codegen/content/docs/images/open-terminal.png b/templates/codegen/content/docs/images/open-terminal.png
diff --git a/templates/codegen/content/docs/images/workbench-name.png b/templates/codegen/content/docs/images/workbench-name.png
diff --git a/templates/codegen/content/docs/index.md b/templates/codegen/content/docs/index.md
diff --git a/templates/codegen/content/docs/pipelines.md b/templates/codegen/content/docs/pipelines.md