Initial commit

.github/workflows/create_branch.yml

@@ -0,0 +1,16 @@
+on: workflow_dispatch
+
+name: Create gh-pages branch
+
+jobs:
+  create-branch:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./
+          force_orphan: true

.github/workflows/mirror.yml

@@ -0,0 +1,58 @@
+on:
+    workflow_dispatch:
+    push:
+      branches: main
+
+name: Mirror to Internal
+env:
+  GITHUB_TOKEN: ${{ secrets.GH_ENTERPRISE_TOKEN }}
+  GHE_USER: ${{ vars.SYNC_USER }}
+  GHE_FULL_USER: ${{ vars.SYNC_USER_NAME }}
+  ENTERPRISE_URL: ${{ vars.ENTERPRISE_GIT_URL }}
+  ENTERPRISE_EMAIL: ${{ vars.SYNC_USER_EMAIL }}
+  TEMPLATE_NAME: 'ibm-client-engineering/solution-template-quarto'
+  CEBOT_GH_TRAVIS_TOKEN: ${{ secrets.CEBOT_GH_TRAVIS_TOKEN }}
+  CEBOT_TRAVIS_API_KEY: ${{ secrets.CEBOT_TRAVIS_API_KEY }}
+  TRAVIS_API_ENDPOINT: ${{ vars.TRAVIS_API_ENDPOINT }}
+
+jobs:
+  verify_and_mirror:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check if remote enterprise repo exists
+        id: repocheck
+        if: ${{github.repository == env.TEMPLATE_NAME}}
+        run: git ls-remote https://${{ env.GHE_USER }}:${{ env.GITHUB_TOKEN }}@${{ env.ENTERPRISE_URL }}/${{ github.repository }} -q --exit-code
+      - name: Create remote repo
+        if: ${{ failure() && steps.repocheck.conclusion == 'failure' && github.repository == env.TEMPLATE_NAME}}
+        run: |
+          echo ${{ env.GITHUB_TOKEN }} > /tmp/token.txt
+          gh auth login -p https -h ${{ env.ENTERPRISE_URL }} --with-token < /tmp/token.txt
+          gh repo create --public ${{ github.repository }}
+      - name: Checkout repo and all branches to stage
+        id: checkout
+        if: ${{github.repository == env.TEMPLATE_NAME}}
+        uses: actions/checkout@v4
+        with:
+          repository: ${{ github.repository }}
+          fetch-depth: 0
+      - name: Mirror the repo up to our internal github
+        id: mirror
+        if: ${{github.repository == env.TEMPLATE_NAME}}
+        uses: yesolutions/mirror-action@master
+        with:
+          REMOTE: 'https://${{ env.ENTERPRISE_URL }}/${{ github.repository }}'
+          GIT_USERNAME: ${{ env.GHE_USER }}
+          GIT_PASSWORD: ${{ env.GITHUB_TOKEN }}
+      - name: Set Travis Var (gh token)
+        id: travis
+        if: ${{github.repository == env.TEMPLATE_NAME}}
+        env:
+          REPO_NAME: "solution-template-quarto"
+        run: |
+          curl -X POST \
+          -H "Content-Type: application/json" \
+          -H "Travis-API-Version: 3" \
+          -H "Authorization: token ${{ env.CEBOT_TRAVIS_API_KEY }}" \
+          -d '{ "env_var.name": "GITHUB_TOKEN", "env_var.value": "${{ env.CEBOT_GH_TRAVIS_TOKEN }}", "env_var.public": false }' \
+          ${{ env.TRAVIS_API_ENDPOINT }}/repo/${{ github.repository_owner }}%2F${{ env.REPO_NAME }}/env_vars

.github/workflows/publish.yml

@@ -0,0 +1,33 @@
+on:
+    workflow_dispatch:
+    push:
+      branches: main
+
+name: Quarto Publish
+
+jobs:
+    build-deploy:
+      runs-on: ubuntu-latest
+      permissions:
+        contents: write
+      steps:
+        - name: Check out repository
+          uses: actions/checkout@v4
+
+        - name: Set up Quarto
+          uses: quarto-dev/quarto-actions/setup@v2
+
+        - name: Install Python and Dependencies
+          uses: actions/setup-python@v5
+          with:
+            python-version: '3.10'
+            cache: 'pip'
+        - run: pip install jupyter
+        - run: pip install -r requirements.txt
+
+        - name: Render and Publish
+          uses: quarto-dev/quarto-actions/publish@v2
+          with:
+            target: gh-pages
+          env:
+            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/template-sync.yml

@@ -0,0 +1,32 @@
+on:
+    # cronjob trigger
+  schedule:
+  - cron:  "0 0 * * 1"
+  # manual trigger
+  workflow_dispatch:
+
+name: Quarto Template Sync
+
+jobs:
+  repo-sync:
+    runs-on: ubuntu-latest
+    # https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs
+    permissions:
+      contents: write
+      pull-requests: write
+
+    steps:
+      # To use this repository's private action, you must check out the repository
+      - name: Checkout
+        uses: actions/checkout@v4
+        # https://github.com/actions/checkout#usage
+        # uncomment if you use submodules within the source repository
+        # with:
+        #   submodules: true
+
+      - name: actions-template-sync
+        uses: AndreasAugustin/actions-template-sync@v2
+        with:
+          source_repo_path: ibm-client-engineering/solution-template-quarto
+          upstream_branch: main # defaults to main
+          pr_labels: template_sync # defaults to template_sync

.gitignore

@@ -0,0 +1,6 @@
+/.quarto/
+/_site
+/docs/*
+
+!docs/docsfile
+_quarto_internal_scss_error.scss

.templatesyncignore

@@ -0,0 +1,2 @@
+:!src/custom.scss
+*

.travis.yml

@@ -0,0 +1,39 @@
+language: python
+python: 
+  - "3.9"
+
+branches:
+  only:
+  - main
+
+# env:
+#   - GITHUB_TOKEN: $secrets.GITHUB_TOKEN
+
+jobs:
+  include:
+    - stage: build and deploy pages
+      before_install:
+        - rm ~/.netrc
+      install:
+        - pip install quarto-cli
+      script:
+        - quarto render --output-dir build
+#      script: 
+#        - quarto publish gh-pages --no-prompt --no-browser --token $GITHUB_TOKEN
+
+      before_deploy: 
+      - rvm --default use 2.7.6
+      deploy:
+      - provider: pages
+        edge:
+          branch: v1.10.16
+        github_url: github.ibm.com
+        github_token: $GITHUB_TOKEN
+        target_branch: gh-pages
+        skip_cleanup: true
+        local_dir: build
+        on:
+          branch: main
+
+stages:
+  - build and deploy pages

README.md

@@ -0,0 +1,20 @@
+# IBM Client Engineering Solutions Documentation Template
+
+## What is this?
+This is a template used to quickly and effectively document assets and solutions created by Client Engineers at IBM. The template outlines the bare minimum requirements that must be documented when publishing your work.
+
+## Install Quarto
+To be able to build and view changes locally for these docs you will need to install the appropriate version of Quarto via Command Line: 
+`pip install quarto-cli` or `brew install --cask quarto` and ensure one of the tools below is installed:
+* VS Code
+* Jupyter
+* RStudio
+* Neovim
+* Text Editor
+
+If the command line install does not work, you can download quarto here: https://quarto.org/docs/download/
+
+## How do I use it?
+1. Change line 9 of the `_quarto.yml` file to the appropriate Project Name of the solution doc.
+2. Change line 21 of the `_quarto.yml` file to the reflect the link to the repo of the newly created solution doc. Ex. https://github.com/ibm-client-engineering/[repo-name]
+3. Assuming that Quarto is already installed, navigate to the appropriate directory with the cloned solution doc repository and run `quarto preview index.qmd` to preview your build locally.

_quarto.yml

@@ -0,0 +1,69 @@
+project:
+  type: website
+  output-dir: docs
+
+language: 
+      search-text-placeholder: Search
+
+website:
+  title: Solutions Hub
+  favicon: images/bee.png
+  page-navigation: true
+  search: 
+    type: textbox
+    show-item-context: true
+    location: navbar
+  navbar:
+    pinned: true
+    logo: images/IBMlogo.png
+    right: 
+      - icon: github
+        href: https://github.com/ibm-client-engineering
+      - icon: linkedin
+        menu:
+          - text: Share on your LinkedIn
+            href:  http://linkedin.com/post
+          - text:  IBM LinkedIn
+            href:  https://www.linkedin.com/company/ibm/
+  sidebar:
+    - title: "Contents"
+      style: docked
+      collapse-level: 1
+      search: false
+      contents:
+        - href: index.qmd
+          text: Problem Definition
+        - section: Solution Overview
+          contents:
+          - text: Prepare
+            href: src/solution_overview/prepare.qmd
+          - text: Environment 
+            href: src/solution_overview/environment.qmd
+          - text: Troubleshooting
+            href: src/solution_overview/troubleshooting.qmd
+        - section: Implementation Methodology
+          contents:
+          - text: Step One
+            href: src/implementation_methodology/stepone-imp.qmd
+          - text: Step Two
+            href: src/implementation_methodology/steptwo-imp.qmd
+          - text: Step Three
+            href: src/implementation_methodology/stepthree-imp.qmd
+        - text: Key Takeaways
+          href: src/key-takeaway.qmd
+
+
+  page-footer: 
+    background: black
+    left: 
+        <div class ="listitem"><a href="https://ibm.com" rel="noopener noreferrer" class="footerLogo"><img src="https://www.ibm.com/brand/experience-guides/developer/8f4e3cc2b5d52354a6d43c8edba1e3c9/02_8-bar-reverse.svg" alt="IBM Logo" class="footer__logo themedComponent_node_modules-@docusaurus-theme-common-lib-components-ThemedComponent-styles-module themedComponent--light_node_modules-@docusaurus-theme-common-lib-components-ThemedComponent-styles-module" width="250" height="250"></a></div>  
+
+
+format:
+  html:
+    theme: src/custom.scss
+    toc: true
+    toc-location: right
+
+
+

index.qmd

@@ -0,0 +1,38 @@
+
+---
+title: "Project Name"
+subtitle: "Subtitle"
+format: html
+---
+```{=html}
+<span class="dot">SL</span> &ensp;Samuel Lee&ensp;
+```
+```{=html}
+<span class="dot">BK</span> &ensp;Bo Kulbacki&ensp;
+```
+<br>
+---
+Description: "Project Name"
+---
+
+## The Why
+
+(High-level description of the business challenges and client pain points)
+
+### Problem Details
+
+Sed elementum convallis quam, sed tempor massa dictum sit amet. Phasellus ultricies ante id massa scelerisque interdum. Vestibulum vitae volutpat felis. Sed metus magna, malesuada vitae odio eu, volutpat aliquam odio. Mauris eget purus ex. Praesent nec gravida lorem. Nam rhoncus bibendum nulla at viverra. Curabitur at diam sem. Pellentesque semper venenatis lorem quis pharetra. Cras venenatis consectetur ante vitae mattis. Etiam in augue vel nunc euismod sodales vitae eu arcu.
+
+Maecenas tempus ultricies sapien, porta suscipit est facilisis quis. Ut imperdiet massa condimentum sapien lobortis, dictum eleifend enim cursus. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Aenean interdum vel velit non dictum. Suspendisse bibendum neque ut nulla condimentum, quis dictum sem consectetur. Integer quis arcu sem. Sed condimentum dolor sed libero posuere, sed tristique nulla cursus. In hac habitasse platea dictumst. Aenean ullamcorper condimentum risus, at semper tortor consequat eu.
+
+Pellentesque a semper nisl, a vehicula libero. Mauris aliquam porttitor nibh ut porttitor. Praesent eu sem lacinia, volutpat dolor id, interdum enim. Etiam sit amet urna rhoncus, iaculis ex hendrerit, suscipit urna. Duis id porta massa, ac ultrices nulla. Vestibulum ut rutrum lacus, ac vulputate libero. Sed metus massa, maximus ac vulputate nec, lacinia sit amet felis.
+
+
+### Additional Context
+
+Sed elementum convallis quam, sed tempor massa dictum sit amet. Phasellus ultricies ante id massa scelerisque interdum. Vestibulum vitae volutpat felis. Sed metus magna, malesuada vitae odio eu, volutpat aliquam odio. Mauris eget purus ex. Praesent nec gravida lorem. Nam rhoncus bibendum nulla at viverra. Curabitur at diam sem. Pellentesque semper venenatis lorem quis pharetra. Cras venenatis consectetur ante vitae mattis. Etiam in augue vel nunc euismod sodales vitae eu arcu.
+
+Maecenas tempus ultricies sapien, porta suscipit est facilisis quis. Ut imperdiet massa condimentum sapien lobortis, dictum eleifend enim cursus. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Aenean interdum vel velit non dictum. Suspendisse bibendum neque ut nulla condimentum, quis dictum sem consectetur. Integer quis arcu sem. Sed condimentum dolor sed libero posuere, sed tristique nulla cursus. In hac habitasse platea dictumst. Aenean ullamcorper condimentum risus, at semper tortor consequat eu.
+
+Pellentesque a semper nisl, a vehicula libero. Mauris aliquam porttitor nibh ut porttitor. Praesent eu sem lacinia, volutpat dolor id, interdum enim. Etiam sit amet urna rhoncus, iaculis ex hendrerit, suscipit urna. Duis id porta massa, ac ultrices nulla. Vestibulum ut rutrum lacus, ac vulputate libero. Sed metus massa, maximus ac vulputate nec, lacinia sit amet felis.
+