/ibm-gsi-cloudnative-journey

Cloud Native Learning Journey to enable GSI Partners to learn cloud native development with the IBM Enterprise Sandbox

Primary LanguageJavaScriptApache License 2.0Apache-2.0

Cloud-Native Learning Journey

This developer enablement will enable technical teams to understand how to use the tools to manage the full lifecycle of Cloud-Native development with IBM Kubernetes Service or managed Red Hat OpenShift on IBM Cloud.

The rendered Learning Journey can be viewed here - Cloud-Native Enablement

To update and manage the Learning Journey follow these steps.

Development guide

Page titles and other metadata

Page titles and other metadata are provided via meta blocks at the top of the page.

---
title: What is Cloud-Native?
description: This is a description
---

Content headings

In most all cases, titles/headings within the page content should use h1-h5 headings (e.g. # - #####) instead of just using bold text. Using headings allows the table of contents to be generated correctly.

Info boxes (Admonitions)

Information boxes are implemented as admonitions. For example:

!!! note "Phasellus posuere in sem ut cursus"

    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
    nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
    massa, nec semper lorem quam in massa.

Many admonition types are supported

e.g. note, abstract, info, tip, success, question, warning, danger, bug, quote

Content tabs

Content tabs are defined using ==== with indented content on the following lines. For example:

=== "Unordered list"

    * Sed sagittis eleifend rutrum
    * Donec vitae suscipit est
    * Nulla tempor lobortis orci

=== "Ordered list"

    1. Sed sagittis eleifend rutrum
    2. Donec vitae suscipit est
    3. Nulla tempor lobortis orci

Grids

Grids and grid cards are defined using html with grid cards classes and dashes (-) for each card.

<div class="grid cards" markdown>

-   :material-clock-fast:{ .lg .middle } __Set up in 5 minutes__

    ---

    Install [`mkdocs-material`](#) with [`pip`](#) and get up
    and running in minutes

    [:octicons-arrow-right-24: Getting started](#)

-   :fontawesome-brands-markdown:{ .lg .middle } __It's just Markdown__

    ---

    Focus on your content and generate a responsive and searchable static site

    [:octicons-arrow-right-24: Reference](#)

-   :material-format-font:{ .lg .middle } __Made to measure__

    ---

    Change the colors, fonts, language, icons, logo and more with a few lines

    [:octicons-arrow-right-24: Customization](#)

-   :material-scale-balance:{ .lg .middle } __Open Source, MIT__

    ---

    Material for MkDocs is licensed under MIT and available on [GitHub]

    [:octicons-arrow-right-24: License](#)

</div>

Development

Clone the repository

git clone

Install dependencies

npm install

This will install all the dependencies necessary to run the environment in development mode and to build and publish the content.

Write content

The content of the Learning Journey is authored through a hybrid of Markdown and React. The content itself is primarily provided using Markdown. React components are sprinkled into the Markdown to provide for a richer and more interactive set of components in the published guide.

To render the content within your local development environment, run the following:

npm run dev:build
npm run dev

Publish Content

Currently, the content is published to the GitHub pages site through the gh-pages branch using the gh-pages npm module. All of the details for handling the publishing are covered within the deploy script. The deploy can be run using the following:

npm run build
npm run deploy

The result of the deploy can be viewed here - https://ibm-gsi-ecosystem.github.io/ibm-gsi-cloudnative-journey/

Note: There is a time delay between when the deploy process completes and when the content is available on the published site.

Resources