Skip to content

Website #102

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 53 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
53 commits
Select commit Hold shift + click to select a range
5f3fb45
initial website setup
Jan 18, 2024
21f653a
Added more assets, added documentation for extension, sdk, and linter
Jan 22, 2024
ef47321
Completed first iteration for vs code extension documentation.
Jan 25, 2024
65e027f
Completed first iteration for operator collection linter documentation.
Jan 25, 2024
d0b05d2
Operator Collection SDK migrated.
Jan 29, 2024
c9dc084
Landing page updated.
Jan 29, 2024
c7d0dbf
Updated docs main overview page using landing.yaml headings and descr…
Jan 29, 2024
726ec93
Updated requirements for extension.
Jan 30, 2024
7f7a98d
Polishing
Jan 30, 2024
d91f14e
Added info to troubleshooting page for VS Code extension, and polishing.
Jan 30, 2024
a498944
Initial docs migration complete.
Jan 30, 2024
24f4d74
Added links to vs code extension change log.
Jan 30, 2024
124032b
Added extension settings documentation
Feb 2, 2024
3085d8a
Installation guide validation additions.
Feb 5, 2024
ee66f17
Added Linter Quick Fix information.
Feb 5, 2024
862fc17
Added markings and attributions (®) where necessary.
Feb 6, 2024
268102e
Added markings and attributions (®) where necessary.
Feb 6, 2024
a1c06d3
Added markings and attributions (®) where necessary.
Feb 6, 2024
a92f27f
Added VS Code Tutorial
Feb 7, 2024
60576d8
Added VS Code Tutorial
Feb 8, 2024
2996547
Added documentation about signing and verifying collections with asym…
Feb 8, 2024
4822739
Validated CI/CD code in verification documentation.
Feb 13, 2024
057066f
typo fixes
Feb 13, 2024
a6bec8f
Minor structure change.
Feb 15, 2024
ec68fe1
Pushing lotusdocs theme repository
Feb 24, 2024
eaf3bdd
Fixed a few typos and errors.
Feb 27, 2024
bf2acc7
Added lotus theme manually.
Feb 27, 2024
4155f79
Added workflow
IzzyMusa Feb 27, 2024
5f55825
Merge pull request #96 from IBM/website-deploy
yemi-kelani Feb 27, 2024
f16a60a
Fixed relative url navigation from home page.
Feb 27, 2024
f90cfae
Fixed relative url navigation from home page.
Feb 27, 2024
f46ffc3
Fixed navigation from home page issues
Feb 27, 2024
6be9e02
Fixed navigation errors from homepage.
Feb 27, 2024
b953877
Fixed broken links, added logo favicons, deleted old readmes
Mar 9, 2024
ef70b93
sync with develope
IzzyMusa Mar 11, 2024
84a5b19
sync with develope
IzzyMusa Mar 11, 2024
79955b7
Merge remote-tracking branch 'origin/develop' into website
Mar 12, 2024
0bd995c
Attempting to fix missing pages issue.
Mar 12, 2024
a264c95
Trigger website deployment
Mar 12, 2024
6c93e4f
Trigger website deployment
Mar 12, 2024
6b49236
Trigger website deployment
Mar 12, 2024
37421be
Trigger website deployment
Mar 12, 2024
467bb64
Trigger website deployment
Mar 12, 2024
e3a7f18
Reverting workflows back to normal.
Mar 12, 2024
89b501b
Trigger website deployment
Mar 12, 2024
737a6a4
Reverting temporary workflow changes.
Mar 12, 2024
265dba7
Deploying minor documentation fixes.
Mar 13, 2024
79d34d9
Reverting temporary workflow changes.
Mar 13, 2024
aa60152
Deploying minor documentation fixes.
Mar 13, 2024
3a60d56
Reverting temporary workflow changes.
Mar 13, 2024
a18e9c0
Media change
Apr 22, 2024
8ff383d
Media change.
Apr 22, 2024
834441a
Reverting changes made for website deployment.
Apr 22, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
79 changes: 79 additions & 0 deletions .github/workflows/hugo-deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# Sample workflow for building and deploying a Hugo site to GitHub Pages
name: Deploy Hugo site to Pages

on:
push:
branches:
- 'main'
paths:
- 'website/**'
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

# Default to bash
defaults:
run:
shell: bash

jobs:
# Build job
build:
runs-on: ubuntu-latest
env:
HUGO_VERSION: 0.123.0
steps:
- name: Install Hugo CLI
run: |
wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb \
&& sudo dpkg -i ${{ runner.temp }}/hugo.deb
- name: Install Dart Sass
run: sudo snap install dart-sass
- name: Checkout
uses: actions/checkout@v4
with:
submodules: recursive
fetch-depth: 0
ref: ${{ github.ref }}
- name: Setup Pages
id: pages
uses: actions/configure-pages@v4
- name: Install Node.js dependencies
run: "[[ -f package-lock.json || -f npm-shrinkwrap.json ]] && npm ci || true"
- name: Build with Hugo
env:
HUGO_ENVIRONMENT: production
HUGO_ENV: production
working-directory: ./website
run: |
hugo \
--gc \
--minify \
--baseURL "${{ steps.pages.outputs.base_url }}/"
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
path: ./website/public


# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v3
1 change: 1 addition & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ on:
paths-ignore:
- 'docs/**'
- '**.md'
- 'website/**'
tags-ignore:
- '**'
pull_request_target:
Expand Down
5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,7 @@ ibm/operator_collection_sdk/local/*
examples/racf-operator/local/*
.DS_Store
.vscode/*
*.idea/
*.idea/

website/public/*
website/resources/*
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@
# Overview
The IBM Operator Collection SDK provides the resources and tools that are needed to develop Operator Collections against the IBM® z/OS® Cloud Broker which is part of the IBM Z® and Cloud Modernization Stack.

Operator Collections are simply [Ansible Collections](https://www.ansible.com/blog/getting-started-with-ansible-collections) that are dynamically converted to [Ansible Operators](https://www.ansible.com/blog/ansible-operator) in Openshift when imported in the [IBM® z/OS® Cloud Broker](https://ibm.biz/ibm-zoscb-install). This allows you to write any [Ansible Playbook](https://docs.ansible.com/ansible/2.9/user_guide/playbooks_intro.html), develop and iterate on it locally, publish to Openshift, and expose a catalog of statefully managed new services.
Operator Collections are simply [Ansible Collections](https://www.ansible.com/blog/getting-started-with-ansible-collections) that are dynamically converted to [Ansible Operators](https://www.ansible.com/blog/ansible-operator) in OpenShift when imported in the [IBM® z/OS® Cloud Broker](https://ibm.biz/ibm-zoscb-install). This allows you to write any [Ansible Playbook](https://docs.ansible.com/ansible/2.9/user_guide/playbooks_intro.html), develop and iterate on it locally, publish to OpenShift, and expose a catalog of statefully managed new services.

The IBM Operator Collection SDK simplifies the development of these Operator Collections by providing:
- The ability to scaffold a new Operator Collection with a preconfigured set of requirements
- The ability to quickly debug your Ansible automation in an operator in Openshift, using a local build of your latest Ansible modifications
- The ability to quickly debug your Ansible automation in an operator in OpenShift, using a local build of your latest Ansible modifications

This project also provides the documented Operator Collection specification, along with a tutorial to guide you along the development process.

Expand Down
2 changes: 1 addition & 1 deletion ibm/operator_collection_sdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The IBM Operator Collection SDK is used to assist in the end to end deployment o

# Prerequisites
- [Openshift Cluster (version 4.10 or later)][openshift]
- [OpenShift Command Line Interface (CLI)][openshift-cli]
- [Openshift Command Line Interface (CLI)][openshift-cli]
- [Ansible CLI Tools (version 2.7 or later)][ansible]
- [Kubernetes Python Client][kubernetes]
- [z/OS Cloud Broker v2.2.0+][broker]
Expand Down
Empty file added website/.hugo_build.lock
Empty file.
5 changes: 5 additions & 0 deletions website/archetypes/default.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
+++
title = '{{ replace .File.ContentBaseName "-" " " | title }}'
date = {{ .Date }}
draft = true
+++
Binary file added website/assets/images/logo/dark/broker.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions website/assets/images/logo/dark/broker.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading