From 7d1235dcc3e16605de46688e97f4fcf294f70bfc Mon Sep 17 00:00:00 2001 From: kramerro-ibm <102995992+kramerro-ibm@users.noreply.github.com> Date: Fri, 23 Feb 2024 12:06:37 -0500 Subject: [PATCH] Initial commit --- .github/dependabot.yml | 11 + .github/workflows/deploy.yml | 43 + .github/workflows/sync.yaml | 159 + .gitignore | 23 + .travis.yml | 35 + CLA.md | 32 + LICENSE | 201 + .../Scripts/examplescript.txt | 0 .../Scripts/examplescript.txt | 0 .../Scripts/examplescript.txt | 0 babel.config.js | 3 + docs/1-ExampleSolution1/1-Refine.mdx | 18 + docs/1-ExampleSolution1/2-Align.mdx | 16 + docs/1-ExampleSolution1/3-Architect.mdx | 11 + docs/1-ExampleSolution1/README.mdx | 7 + docs/1-ExampleSolution1/_category_.json | 6 + docs/2-ExampleSolution2/1-Prerequisites.mdx | 6 + docs/2-ExampleSolution2/README.mdx | 7 + docs/2-ExampleSolution2/_category_.json | 6 + docs/3-ExampleSolution3/1-Prepare.mdx | 8 + docs/3-ExampleSolution3/2-Deploy.mdx | 7 + docs/3-ExampleSolution3/3-Validate.mdx | 6 + docs/3-ExampleSolution3/4-Integrate.mdx | 6 + docs/3-ExampleSolution3/README.mdx | 7 + docs/3-ExampleSolution3/_category_.json | 6 + docs/README.mdx | 29 + docusaurus.config.js | 191 + flight-logs/2023-06-01-cocreate.md | 7 + package.json | 62 + sidebars.js | 34 + src/components/BrowserWindow/IframeWindow.tsx | 33 + src/components/BrowserWindow/index.tsx | 67 + .../BrowserWindow/styles.module.css | 87 + src/components/HomepageFeatures/index.tsx | 70 + .../HomepageFeatures/styles.module.css | 11 + src/css/custom.css | 257 + src/css/external-link.css | 73 + src/css/icons/a.css | 1599 +++ src/css/icons/arc.css | 7 + src/css/icons/b.css | 721 + src/css/icons/c.css | 1148 ++ src/css/icons/d.css | 707 + src/css/icons/e.css | 504 + src/css/icons/extra.css | 70 + src/css/icons/f.css | 797 ++ src/css/icons/g.css | 1015 ++ src/css/icons/h.css | 504 + src/css/icons/i.css | 471 + src/css/icons/j.css | 301 + src/css/icons/k.css | 445 + src/css/icons/l.css | 567 + src/css/icons/m.css | 1083 ++ src/css/icons/n.css | 575 + src/css/icons/o.css | 502 + src/css/icons/p.css | 1198 ++ src/css/icons/q.css | 182 + src/css/icons/r.css | 746 ++ src/css/icons/s.css | 1669 +++ src/css/icons/t.css | 885 ++ src/css/icons/u.css | 254 + src/css/icons/v.css | 396 + src/css/icons/w.css | 699 + src/css/icons/x.css | 120 + src/css/icons/y.css | 121 + src/css/icons/z.css | 238 + src/css/navbar.css | 0 src/pages/index.module.css | 23 + src/pages/markdown-page.md | 7 + src/theme/EditThisPage/index.tsx | 21 + src/theme/EditThisPage/styles.module.css | 3 + src/theme/ExternalLink/index.tsx | 8 + src/theme/ExternalLink/styles.module.css | 15 + src/theme/mindmap.js | 39 + static/.nojekyll | 0 static/img/docusaurus-social-card.jpg | Bin 0 -> 128133 bytes static/img/favicon.ico | Bin 0 -> 103134 bytes static/img/logo-dark.svg | 3 + static/img/logo-light.svg | 3 + static/img/logo.svg | 3 + tsconfig.json | 7 + update_docusaurus.sh | 16 + yarn.lock | 10883 ++++++++++++++++ 82 files changed, 30100 insertions(+) create mode 100644 .github/dependabot.yml create mode 100644 .github/workflows/deploy.yml create mode 100644 .github/workflows/sync.yaml create mode 100644 .gitignore create mode 100644 .travis.yml create mode 100644 CLA.md create mode 100644 LICENSE create mode 100644 assets/ExampleSolution1/Scripts/examplescript.txt create mode 100644 assets/ExampleSolution2/Scripts/examplescript.txt create mode 100644 assets/ExampleSolution3/Scripts/examplescript.txt create mode 100644 babel.config.js create mode 100644 docs/1-ExampleSolution1/1-Refine.mdx create mode 100644 docs/1-ExampleSolution1/2-Align.mdx create mode 100644 docs/1-ExampleSolution1/3-Architect.mdx create mode 100644 docs/1-ExampleSolution1/README.mdx create mode 100644 docs/1-ExampleSolution1/_category_.json create mode 100644 docs/2-ExampleSolution2/1-Prerequisites.mdx create mode 100644 docs/2-ExampleSolution2/README.mdx create mode 100644 docs/2-ExampleSolution2/_category_.json create mode 100644 docs/3-ExampleSolution3/1-Prepare.mdx create mode 100644 docs/3-ExampleSolution3/2-Deploy.mdx create mode 100644 docs/3-ExampleSolution3/3-Validate.mdx create mode 100644 docs/3-ExampleSolution3/4-Integrate.mdx create mode 100644 docs/3-ExampleSolution3/README.mdx create mode 100644 docs/3-ExampleSolution3/_category_.json create mode 100644 docs/README.mdx create mode 100644 docusaurus.config.js create mode 100644 flight-logs/2023-06-01-cocreate.md create mode 100644 package.json create mode 100644 sidebars.js create mode 100644 src/components/BrowserWindow/IframeWindow.tsx create mode 100644 src/components/BrowserWindow/index.tsx create mode 100644 src/components/BrowserWindow/styles.module.css create mode 100644 src/components/HomepageFeatures/index.tsx create mode 100644 src/components/HomepageFeatures/styles.module.css create mode 100644 src/css/custom.css create mode 100644 src/css/external-link.css create mode 100755 src/css/icons/a.css create mode 100755 src/css/icons/arc.css create mode 100755 src/css/icons/b.css create mode 100755 src/css/icons/c.css create mode 100755 src/css/icons/d.css create mode 100755 src/css/icons/e.css create mode 100755 src/css/icons/extra.css create mode 100755 src/css/icons/f.css create mode 100755 src/css/icons/g.css create mode 100755 src/css/icons/h.css create mode 100755 src/css/icons/i.css create mode 100755 src/css/icons/j.css create mode 100755 src/css/icons/k.css create mode 100755 src/css/icons/l.css create mode 100755 src/css/icons/m.css create mode 100755 src/css/icons/n.css create mode 100755 src/css/icons/o.css create mode 100755 src/css/icons/p.css create mode 100755 src/css/icons/q.css create mode 100755 src/css/icons/r.css create mode 100755 src/css/icons/s.css create mode 100755 src/css/icons/t.css create mode 100755 src/css/icons/u.css create mode 100755 src/css/icons/v.css create mode 100755 src/css/icons/w.css create mode 100755 src/css/icons/x.css create mode 100755 src/css/icons/y.css create mode 100755 src/css/icons/z.css create mode 100644 src/css/navbar.css create mode 100644 src/pages/index.module.css create mode 100644 src/pages/markdown-page.md create mode 100644 src/theme/EditThisPage/index.tsx create mode 100644 src/theme/EditThisPage/styles.module.css create mode 100644 src/theme/ExternalLink/index.tsx create mode 100644 src/theme/ExternalLink/styles.module.css create mode 100644 src/theme/mindmap.js create mode 100644 static/.nojekyll create mode 100644 static/img/docusaurus-social-card.jpg create mode 100644 static/img/favicon.ico create mode 100644 static/img/logo-dark.svg create mode 100644 static/img/logo-light.svg create mode 100644 static/img/logo.svg create mode 100644 tsconfig.json create mode 100755 update_docusaurus.sh create mode 100644 yarn.lock diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 00000000..ac6621f1 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,11 @@ +# To get started with Dependabot version updates, you'll need to specify which +# package ecosystems to update and where the package manifests are located. +# Please see the documentation for all configuration options: +# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates + +version: 2 +updates: + - package-ecosystem: "" # See documentation for possible values + directory: "/" # Location of package manifests + schedule: + interval: "weekly" diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml new file mode 100644 index 00000000..9ee918de --- /dev/null +++ b/.github/workflows/deploy.yml @@ -0,0 +1,43 @@ +name: Site Build + +on: + pull_request: + types: + - closed + branches: + - main +jobs: + deploy: + name: Deploy to GitHub Pages + runs-on: ubuntu-latest + permissions: + contents: write + concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + steps: + - uses: actions/checkout@v3 + + - uses: actions/setup-node@v3 + with: + node-version: 18 + + - name: Install dependencies + run: yarn install --frozen-lockfile + - name: Build website + run: yarn build + + # Popular action to deploy to GitHub Pages: + # Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus + - name: Deploy to GitHub Pages + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + # Build output to publish to the `gh-pages` branch: + publish_dir: ./build + # The following lines assign commit authorship to the official + # GH-Actions bot for deploys to `gh-pages` branch: + # https://github.com/actions/checkout/issues/13#issuecomment-724415212 + # The GH actions bot is used by default if you didn't specify the two fields. + # You can swap them out with your own user credentials. + user_name: github-actions[bot] + user_email: 41898282+github-actions[bot]@users.noreply.github.com diff --git a/.github/workflows/sync.yaml b/.github/workflows/sync.yaml new file mode 100644 index 00000000..4c01a32d --- /dev/null +++ b/.github/workflows/sync.yaml @@ -0,0 +1,159 @@ +name: Sync with GitHub Enterprise +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 }} + DEFAULT_TEMPLATE: ${{ vars.REPO_TEMPLATE }} + COMMIT_MESSAGE: Pushing updates from Public to Enterprise + COMMIT_AUTHOR: Friendly Neighborhood CEBOT + 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 }} + ENTERPRISE_PAGES_URL: ${{ vars.ENTERPRISE_PAGES_URL }} + +on: + push: + branches: + - main + +jobs: + verify_and_mirror: + runs-on: ubuntu-latest + steps: + - name: Check if remote enterprise repo exists + id: repocheck + 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' }} + 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: ${{ failure() && steps.repocheck.conclusion == 'failure' }} + uses: actions/checkout@v4 + with: + repository: ${{ github.repository }} + fetch-depth: 0 + + - name: Mirror the repo up to our internal github + id: mirror +# if: ${{ failure() && steps.check_directory.conclusion != 'failure' }} + 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 repo name as an env var + id: repo_name +# if: ${{ failure() && steps.check_directory.conclusion != 'failure' }} + run: | + echo ${{ github.repository }}| awk -F/ '{print "REPO_NAME="$2}' >> "$GITHUB_OUTPUT" + + - name: Set Travis Vars + id: travis +# if: ${{ failure() && steps.check_directory.conclusion != 'failure' }} + env: + REPO_NAME: ${{ steps.repo_name.outputs.REPO_NAME }} + 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": "ORG", "env_var.value": "${{ github.repository_owner }}", "env_var.public": true }' \ + ${{ env.TRAVIS_API_ENDPOINT }}/repo/${{ github.repository_owner }}%2F${{ env.REPO_NAME }}/env_vars + 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": "REPO", "env_var.value": "${{ env.REPO_NAME }}", "env_var.public": true }' \ + ${{ env.TRAVIS_API_ENDPOINT }}/repo/${{ github.repository_owner }}%2F${{ env.REPO_NAME }}/env_vars + 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 + 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": "PAGES_URL", "env_var.value": "${{ env.ENTERPRISE_PAGES_URL }}", "env_var.public": true }' \ + ${{ env.TRAVIS_API_ENDPOINT }}/repo/${{ github.repository_owner }}%2F${{ env.REPO_NAME }}/env_vars + + +# update: +# runs-on: ubuntu-latest +# steps: +# - name: Checkout Enterprise repo and all branches +# uses: actions/checkout@v4 +# with: +# github-server-url: https://${{ env.GHE_USER }}@${{ env.ENTERPRISE_URL }} +# repository: ${{ github.repository }} +# token: ${{ env.GITHUB_TOKEN }} +# - name: See if dashboard directory exists and create if it doesn't +# id: check_directory +# uses: JJ/files-present-action@releases/v1 +# with: +# files: 'dashboard/README.md' +# - name: No Dashboard +# if: ${{ failure() && steps.check_directory.conclusion == 'failure' }} +# run: | +# git config --local user.name ${{ env.GHE_USER }} +# git config --local user.email "${{ env.GHE_USER }}@users.noreply.github.com" +# mkdir ./dashboard +# echo "README" > ./dashboard/README.md +# git add ./dashboard +# git commit -m "Dashboard directory created!" +# git push +## git remote set-url origin https://${{ env.GHE_USER }}:${{ env.GITHUB_TOKEN }}@${{ env.ENTERPRISE_URL }}/${{ github.repository }} +## git push +## - name: Push changes # push the output folder to your repo +## if: ${{ failure() && steps.check_directory.conclusion == 'failure' }} +## uses: ad-m/github-push-action@master +### uses: justjavac/action-gh-push@v1 +## with: +## GITHUB_TOKEN: ${{ env.GITHUB_TOKEN }} +## repository: 'https://${{ env.ENTERPRISE_URL }}/${{ github.repository }}' +## force: true + +# sync: +# runs-on: ubuntu-latest +# steps: +# - name: Checkout our public repo +# uses: actions/checkout@v4 +# with: +# repository: ${{ github.repository }} +# fetch-depth: 0 +# path: public +## - name: Checkout our enterprise repo +## uses: actions/checkout@v4 +## with: +## github-server-url: https://${{ env.GHE_USER }}@${{ env.ENTERPRISE_URL }} +## repository: ${{ github.repository }} +## fetch-depth: 0 +## token: ${{ env.GITHUB_TOKEN }} +## path: enterprise +# - name: Clone our enterprise repo +# run: | +# git config --global user.name "${{ env.COMMIT_AUTHOR }}" +# git config --global user.email ${{ env.GHE_USER }}@users.noreply.github.com +# git clone https://${{ env.GHE_USER}}:${{ env.GITHUB_TOKEN }}@${{ env.ENTERPRISE_URL }}/${{ github.repository }}.git enterprise +# - name: Copy over all changed files from public to enterprise +# run: | +# rsync -auvr --exclude '.git' --exclude 'docusaurus.config.js' --exclude '.travis.yml' public/* enterprise +# cd enterprise +# git config --global user.name "${{ env.COMMIT_AUTHOR }}" +# git config --global user.email ${{ env.GHE_USER }}@users.noreply.github.com +# git add . +# git commit -a -m "${{ env.COMMIT_MESSAGE }}" +# - name: Push the changes to enterprise github +# uses: ad-m/github-push-action@master +# with: +# github_token: ${{ env.GITHUB_TOKEN }} +# \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..46484104 --- /dev/null +++ b/.gitignore @@ -0,0 +1,23 @@ + +*.DS_Store +# Dependencies +/node_modules + +# Production +/build + +# Generated files +.docusaurus +.cache-loader + +# Misc +.DS_Store +.env.local +.env.development.local +.env.test.local +.env.production.local +package-lock.json + +npm-debug.log* +yarn-debug.log* +yarn-error.log* diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 00000000..4abfbd29 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,35 @@ +language: ruby + +branches: + only: + - main + +#env: +# - IMAGE_TAG=latest IMAGE_NAME=angel-watson-assistant-demo IBM_REGISTRY_NAMESPACE=watson-assistant + +#services: +# - docker + +jobs: + include: + - stage: build and deploy pages + before_install: + - bash update_docusaurus.sh $ORG $REPO $PAGES_URL + install: + - yarn upgrade +# - yarn install --frozen-lockfile + - yarn install + script: + - yarn build + deploy: + - provider: pages + 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 diff --git a/CLA.md b/CLA.md new file mode 100644 index 00000000..2f2f4aa8 --- /dev/null +++ b/CLA.md @@ -0,0 +1,32 @@ +IBM Contributor License Agreement +================================= + +Version 1.0.0 January 14, 2014 + +In order for You (as defined below) to make intellectual property Contributions (as defined below) now or in the future to IBM GitHub repositories, +You must agree to this Contributor License Agreement ("CLA"). + +Please read this CLA carefully before accepting its terms. By accepting the CLA, You are agreeing to be bound by its terms. +If You submit a Pull Request against an IBM repository on GitHub You must include in the Pull Request a statement of Your acceptance of this CLA. + +As used in this CLA: +(i) "You" (or "Your") shall mean the entity that is making this Agreement with IBM; +(ii)"Contribution" shall mean any original work of authorship, including any modifications or additions to an existing work, that is submitted by You to IBM for inclusion in, +or documentation of, any of the IBM GitHub repositories; +(iii) "Submit" (or "Submitted") means any form of communication sent to IBM (e.g. the content You post in a GitHub Issue or submit as part of a GitHub Pull Request). + +This agreement applies to all Contributions You Submit. + +This CLA, and the license(s) associated with the particular IBM GitHub repositories You are contributing to, provides a license to Your Contributions to IBM and downstream consumers, +but You still own Your Contributions, and except for the licenses provided for in this CLA, You reserve all right, title and interest in Your Contributions. + +IBM requires that each Contribution You Submit now or in the future comply with the following four commitments. + +1) You will only Submit Contributions where You have authored 100% of the content. +2) You will only Submit Contributions to which You have the necessary rights. This means that if You are employed You have received the necessary permissions from Your employer to make the +Contributions. +3) Whatever content You Contribute will be provided under the license(s) associated with the particular IBM GitHub repository You are contributing to. +4) You understand and agree that IBM GitHub repositories and Your contributions are public, and that a record of the contribution (including all personal information You submit with it) +is maintained indefinitely and may be redistributed consistent with the license(s) involved. +You will promptly notify the IBM if You become aware of any facts or circumstances that would make these commitments inaccurate in any way. +To do so, please create an Issue in the appropriate GitHub repository. diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..261eeb9e --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/assets/ExampleSolution1/Scripts/examplescript.txt b/assets/ExampleSolution1/Scripts/examplescript.txt new file mode 100644 index 00000000..e69de29b diff --git a/assets/ExampleSolution2/Scripts/examplescript.txt b/assets/ExampleSolution2/Scripts/examplescript.txt new file mode 100644 index 00000000..e69de29b diff --git a/assets/ExampleSolution3/Scripts/examplescript.txt b/assets/ExampleSolution3/Scripts/examplescript.txt new file mode 100644 index 00000000..e69de29b diff --git a/babel.config.js b/babel.config.js new file mode 100644 index 00000000..e00595da --- /dev/null +++ b/babel.config.js @@ -0,0 +1,3 @@ +module.exports = { + presets: [require.resolve('@docusaurus/core/lib/babel/preset')], +}; diff --git a/docs/1-ExampleSolution1/1-Refine.mdx b/docs/1-ExampleSolution1/1-Refine.mdx new file mode 100644 index 00000000..c568bbba --- /dev/null +++ b/docs/1-ExampleSolution1/1-Refine.mdx @@ -0,0 +1,18 @@ +--- +id: refine +sidebar_position: 1 +title: Refine +custom_edit_url: null +--- + +# Design Thinking + +## Personas + + Empathy mapping and persona development + Identifying pain points and opportunities + +## Requirements + + Agile user stories and acceptance criteria + diff --git a/docs/1-ExampleSolution1/2-Align.mdx b/docs/1-ExampleSolution1/2-Align.mdx new file mode 100644 index 00000000..5d79acd8 --- /dev/null +++ b/docs/1-ExampleSolution1/2-Align.mdx @@ -0,0 +1,16 @@ +--- +id: define +sidebar_position: 2 +title: Define +custom_edit_url: null +--- +## Vision + +### Purpose + +### Objectives + +### Target Outcomes & Success Metrics + +### Scope & Roadmap + diff --git a/docs/1-ExampleSolution1/3-Architect.mdx b/docs/1-ExampleSolution1/3-Architect.mdx new file mode 100644 index 00000000..c73283d9 --- /dev/null +++ b/docs/1-ExampleSolution1/3-Architect.mdx @@ -0,0 +1,11 @@ +--- +id: architect +sidebar_position: 3 +title: Architect +custom_edit_url: null +--- + + +## Block View + +## Architecture Decisions diff --git a/docs/1-ExampleSolution1/README.mdx b/docs/1-ExampleSolution1/README.mdx new file mode 100644 index 00000000..4b7d5ccb --- /dev/null +++ b/docs/1-ExampleSolution1/README.mdx @@ -0,0 +1,7 @@ +--- +sidebar_position: 1 +slug: /solution1 +title: 'Solution 1' +custom_edit_url: null +--- +### Solution 1 \ No newline at end of file diff --git a/docs/1-ExampleSolution1/_category_.json b/docs/1-ExampleSolution1/_category_.json new file mode 100644 index 00000000..dc2ae944 --- /dev/null +++ b/docs/1-ExampleSolution1/_category_.json @@ -0,0 +1,6 @@ +{ + "label": "Solution 1", + "position": 2, + "collapsed": true, + "link": {"type": "doc", "id": "README"} +} diff --git a/docs/2-ExampleSolution2/1-Prerequisites.mdx b/docs/2-ExampleSolution2/1-Prerequisites.mdx new file mode 100644 index 00000000..827b9439 --- /dev/null +++ b/docs/2-ExampleSolution2/1-Prerequisites.mdx @@ -0,0 +1,6 @@ +--- +id: prerequisites +sidebar_position: 1 +title: Prerequisites +custom_edit_url: null +--- \ No newline at end of file diff --git a/docs/2-ExampleSolution2/README.mdx b/docs/2-ExampleSolution2/README.mdx new file mode 100644 index 00000000..36f8d6a9 --- /dev/null +++ b/docs/2-ExampleSolution2/README.mdx @@ -0,0 +1,7 @@ +--- +sidebar_position: 2 +slug: /solution2 +title: 'Solution 2' +custom_edit_url: null +--- +### Solution 2 \ No newline at end of file diff --git a/docs/2-ExampleSolution2/_category_.json b/docs/2-ExampleSolution2/_category_.json new file mode 100644 index 00000000..cc4678cc --- /dev/null +++ b/docs/2-ExampleSolution2/_category_.json @@ -0,0 +1,6 @@ +{ + "label": "Solution 2", + "position": 2, + "collapsed": true, + "link": {"type": "doc", "id": "README"} +} diff --git a/docs/3-ExampleSolution3/1-Prepare.mdx b/docs/3-ExampleSolution3/1-Prepare.mdx new file mode 100644 index 00000000..2c49f443 --- /dev/null +++ b/docs/3-ExampleSolution3/1-Prepare.mdx @@ -0,0 +1,8 @@ +--- +id: solution-prepare +sidebar_position: 1 +title: Prepare +custom_edit_url: null +--- + +## Pre-Requisites diff --git a/docs/3-ExampleSolution3/2-Deploy.mdx b/docs/3-ExampleSolution3/2-Deploy.mdx new file mode 100644 index 00000000..a3f53ac3 --- /dev/null +++ b/docs/3-ExampleSolution3/2-Deploy.mdx @@ -0,0 +1,7 @@ +--- +id: solution-deploy +sidebar_position: 2 +title: Deploy +custom_edit_url: null +--- + diff --git a/docs/3-ExampleSolution3/3-Validate.mdx b/docs/3-ExampleSolution3/3-Validate.mdx new file mode 100644 index 00000000..5677d256 --- /dev/null +++ b/docs/3-ExampleSolution3/3-Validate.mdx @@ -0,0 +1,6 @@ +--- +id: solution-validate +sidebar_position: 3 +title: Validate +custom_edit_url: null +--- \ No newline at end of file diff --git a/docs/3-ExampleSolution3/4-Integrate.mdx b/docs/3-ExampleSolution3/4-Integrate.mdx new file mode 100644 index 00000000..498260d3 --- /dev/null +++ b/docs/3-ExampleSolution3/4-Integrate.mdx @@ -0,0 +1,6 @@ +--- +id: solution-integrate +sidebar_position: 4 +title: Integrate +custom_edit_url: null +--- \ No newline at end of file diff --git a/docs/3-ExampleSolution3/README.mdx b/docs/3-ExampleSolution3/README.mdx new file mode 100644 index 00000000..f215f560 --- /dev/null +++ b/docs/3-ExampleSolution3/README.mdx @@ -0,0 +1,7 @@ +--- +sidebar_position: 3 +slug: /solution3 +title: 'Solution 3' +custom_edit_url: null +--- +### Solution 3 \ No newline at end of file diff --git a/docs/3-ExampleSolution3/_category_.json b/docs/3-ExampleSolution3/_category_.json new file mode 100644 index 00000000..b390c3a9 --- /dev/null +++ b/docs/3-ExampleSolution3/_category_.json @@ -0,0 +1,6 @@ +{ + "label": "Solution 3", + "position": 3, + "collapsed": true, + "link": {"type": "doc", "id": "README"} +} diff --git a/docs/README.mdx b/docs/README.mdx new file mode 100644 index 00000000..8abced4a --- /dev/null +++ b/docs/README.mdx @@ -0,0 +1,29 @@ +--- +sidebar_position: 1 +slug: / +title: ' Solutions' +custom_edit_url: null +--- + +```mermaid +graph LR; + A(Align) --> B(Design); + B --> C(Build); + C --> D(Manage); +``` + +#### Flight Path +This is a living document for an adoption journey that synthesizes the best practices from IBM when considering and implementing **`solution`** + +#### Working In The Open + +The Flight Path approach embodies IBM Client Engineering's dedication to transparency and collaboration, which is evident through the creation of this accessible repository that showcases real-life customer experiences. By sharing this knowledge, IBM aims to develop user-friendly and scalable landing zones that encourage the adoption of IBM Technology while prioritizing innovation and user experience. This repository represents IBM Client Engineering's commitment to working in the open, where stakeholders and interested parties can participate, provide feedback and benefit from collective knowledge. + +:::info + +IBM Client Engineering is a **no-cost** investment in IBM's customers to co-create and innovate leveraging IBM technology and methodologies. We partner with you to help you solve your business challenges. [Engage us today!](https://www.ibm.com/client-engineering) + +::: + +[![Site Build](https://github.com/ibm-client-engineering/solution-filenet-aws/actions/workflows/deploy.yml/badge.svg)](https://github.com/ibm-client-engineering/solution-filenet-aws/actions/workflows/deploy.yml) + \ No newline at end of file diff --git a/docusaurus.config.js b/docusaurus.config.js new file mode 100644 index 00000000..b39551ee --- /dev/null +++ b/docusaurus.config.js @@ -0,0 +1,191 @@ +// @ts-check +// Note: type annotations allow type checking and IDEs autocompletion + +const lightCodeTheme = require("prism-react-renderer").themes.oceanicNext; +const darkCodeTheme = require("prism-react-renderer").themes.oceanicNext; + +async function createconfig() { + const { remarkKroki } = await import("remark-kroki"); + + /** @type {import("@docusaurus/types").Config} */ + const config = { + + markdown: { + mermaid: true, + }, + themes: ["@docusaurus/theme-mermaid", "@docusaurus/theme-live-codeblock"], + title: "IBM Client Engineering", + tagline: "Build Faster. Together.", + favicon: "img/favicon.ico", + + // Set the production url of your site here + url: "https://ibm-client-engineering.github.io", + // Set the // pathname under which your site is served + // For GitHub pages deployment, it is often "//" + baseUrl: "/solution-name/", + + + // GitHub pages deployment config. + // If you aren"t using GitHub pages, you don"t need these. + organizationName: "ibm-client-engineering", // Usually your GitHub org/user name. + projectName: "solution-name", // Usually your repo name. + + onBrokenLinks: "throw", + onBrokenMarkdownLinks: "warn", + + // ... + + plugins: [ + [require.resolve("@cmfcmf/docusaurus-search-local"), {}], + [require.resolve("docusaurus-plugin-image-zoom"), {}], + [ + "@docusaurus/plugin-sitemap", + { + changefreq: "hourly", + id: "site", + filename: "sitemap.xml", + priority: 0.5, + }, + ], + [ + "@docusaurus/plugin-google-gtag", + { + trackingID: "G-GB0XWXF3GE", + anonymizeIP: true, + }, + ], + ], + + // or, if you want to specify options + + + // Even if you don"t use internalization, you can use this field to set useful + // metadata like html lang. For example, if your site is Chinese, you may want + // to replace "en" with "zh-Hans". + i18n: { + defaultLocale: "en", + locales: ["en"], + }, + + presets: [ + [ + "classic", + /** @type {import("@docusaurus/preset-classic").Options} */ + ({ + docs: { + remarkPlugins: [[remarkKroki, { server: "https://kroki.io/", output: "inline-svg" }]], + routeBasePath: "/", + sidebarPath: require.resolve("./sidebars.js"), + // Please change this to your repo. + // Remove this to remove the "edit this page" links. + editUrl: + "https://github.com/ibm-client-engineering/solution-name/tree/main/packages/create-docusaurus/templates/shared/", + }, + theme: { + customCss: require.resolve("./src/css/custom.css"), + }, + blog: { + path: "flight-logs", + // Simple use-case: string editUrl + // editUrl: "https://github.com/facebook/docusaurus/edit/main/website/", + // Advanced use-case: functional editUrl + editUrl: ({ locale, blogDirPath, blogPath, permalink }) => + "https://github.com/ibm-client-engineering/solution-name/edit/main/${blogDirPath}/${blogPath}", + blogTitle: "Journey Log", + blogSidebarTitle: "All our logs", + postsPerPage: 10, + remarkPlugins: [], + rehypePlugins: [], + } + }), + ], + ], + + themeConfig: + /** @type {import("@docusaurus/preset-classic").ThemeConfig} */ + ({ + metadata: [{ name: "keywords", content: "ibm client engineering, open solutions library, filenet, eks, aws, cp4ba, filenet on aws eks" }], + mermaid: { + theme: { light: "neutral", dark: "dark" }, + }, + // Replace with your project"s social card + image: "img/docusaurus-social-card.jpg", + tableOfContents: { + minHeadingLevel: 2, + maxHeadingLevel: 5, + }, + zoom: { + selector: ".markdown :not(a) > img", + background: { + light: "rgb(255, 255, 255)", + dark: "rgb(50, 50, 50)" + }, + config: { + // options you can specify via https://github.com/francoischalifour/medium-zoom#usage + }, + }, + navbar: { + title: "| IBM Solution Document", + logo: { + alt: "My Site Logo", + src: "img/logo.svg", + srcDark: "img/logo-dark.svg", + width: 200, + height: 200, + }, + items: [ + // { + // type: "doc", + // docId: "intro", + // position: "left", + // label: "Section", + // }, + {to: "/", label: "Flight Path", position: "right"}, + {to: "blog", label: "Flight Logs", position: "right"}, + { + href: "https://github.com/ibm-client-engineering/solution-name", + className: "header-github-link", + position: "right", + }, + ], + }, + footer: { + logo: { + alt: "IBM Logo", + src: "https://upload.wikimedia.org/wikipedia/commons/5/51/IBM_logo.svg", + href: "https://ibm.com", + height: 150, + width: 150, + + }, + // style: "dark", + links: [ + { + title: "Explore", + items: [ + { + label: "IBM", + to: "https://www.ibm.com/", + }, + { + label: "IBM Client Engineering - Open Solutions Library", + to: "https://www.ibm.com/client-engineering", + }, + ], + + } + + ] + }, + prism: { + theme: require("prism-react-renderer").themes.oceanicNext, + darkTheme: require("prism-react-renderer").themes.oceanicNext, + }, + }), + }; + + return config; + +} + +module.exports = createconfig; \ No newline at end of file diff --git a/flight-logs/2023-06-01-cocreate.md b/flight-logs/2023-06-01-cocreate.md new file mode 100644 index 00000000..2487a070 --- /dev/null +++ b/flight-logs/2023-06-01-cocreate.md @@ -0,0 +1,7 @@ +--- +title: Log - Sprint 1 🛫 +description: Flight Log of Co-Creation Activities +slug: flight-log-4 +tags: [log, sprint ] +--- + diff --git a/package.json b/package.json new file mode 100644 index 00000000..e699401d --- /dev/null +++ b/package.json @@ -0,0 +1,62 @@ +{ + "name": "website", + "version": "0.0.0", + "private": true, + "scripts": { + "docusaurus": "docusaurus", + "start": "docusaurus start", + "build": "docusaurus build", + "swizzle": "docusaurus swizzle", + "deploy": "docusaurus deploy", + "clear": "docusaurus clear", + "serve": "docusaurus serve", + "write-translations": "docusaurus write-translations", + "write-heading-ids": "docusaurus write-heading-ids", + "typecheck": "tsc" + }, + "dependencies": { + "@carbon/colors": "^11.20.0", + "@carbon/grid": "^11.21.0", + "@carbon/icons-react": "^11.32.0", + "@carbon/motion": "^11.16.0", + "@carbon/type": "^11.25.0", + "@cmfcmf/docusaurus-search-local": "^1.1.0", + "@docusaurus/core": "^3.1.0", + "@docusaurus/plugin-google-gtag": "^3.1.0", + "@docusaurus/plugin-sitemap": "^3.1.0", + "@docusaurus/preset-classic": "^3.1.0", + "@docusaurus/theme-live-codeblock": "^3.1.0", + "@docusaurus/theme-mermaid": "^3.1.0", + "@mdx-js/react": "^3.0.0", + "clsx": "^2.0.0", + "docusaurus-plugin-image-zoom": "^1.0.1", + "docusaurus-plugin-remote-content": "^3.1.0", + "markmap-common": "^0.15.6", + "markmap-lib": "^0.15.7", + "markmap-view": "^0.15.6", + "prism-react-renderer": "^2.3.0", + "react": "^18.2.0", + "react-dom": "^18.2.0", + "remark-kroki": "^0.2.12" + }, + "devDependencies": { + "@docusaurus/module-type-aliases": "^3.0.1", + "@tsconfig/docusaurus": "^2.0.2", + "typescript": "^5.3.3" + }, + "browserslist": { + "production": [ + ">0.5%", + "not dead", + "not op_mini all" + ], + "development": [ + "last 1 chrome version", + "last 1 firefox version", + "last 1 safari version" + ] + }, + "engines": { + "node": ">=18.0" + } +} diff --git a/sidebars.js b/sidebars.js new file mode 100644 index 00000000..14b45163 --- /dev/null +++ b/sidebars.js @@ -0,0 +1,34 @@ +/** + * Creating a sidebar enables you to: + - create an ordered group of docs + - render a sidebar for each doc of that group + - provide next/previous navigation + + The sidebars can be generated from the filesystem, or explicitly defined here. + + Create as many sidebars as you want. + */ + +// @ts-check + +/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ +const sidebars = { + // By default, Docusaurus generates a sidebar from the docs folder structure + tutorialSidebar: [{type: 'autogenerated', dirName: '.'}], + + // But you can create a sidebar manually + /* + tutorialSidebar: [ + 'intro', + 'hello', + { + type: 'category', + label: 'Tutorial', + items: ['tutorial-basics/create-a-document'], + }, + ], + */ +}; + +module.exports = sidebars; + diff --git a/src/components/BrowserWindow/IframeWindow.tsx b/src/components/BrowserWindow/IframeWindow.tsx new file mode 100644 index 00000000..10512e77 --- /dev/null +++ b/src/components/BrowserWindow/IframeWindow.tsx @@ -0,0 +1,33 @@ +/** + * Copyright (c) Facebook, Inc. and its affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +import React from 'react'; + +import BrowserWindow from './index'; + +// Quick and dirty component, to improve later if needed +export default function IframeWindow({url}: {url: string}): JSX.Element { + return ( +
+ +