Git Product home page Git Product logo

docs.kuadrant.io's Introduction

Kuadrant Docs

Installing mkdocs

pip install mkdocs

And dependencies pip install -r requirements.txt

Running Locally

mkdocs serve -s

The docs should then be available locally from http://127.0.0.1:8000/

Note: mkdocs will automatically clone component repositories as configured via mkdocs.yml.

Building

mkdocs build -s

Outputs static content to site.

Deploying

This is deployed via GitHub Pages, on merge to main.

If you need to re-trigger a deployment from main for any reason, manually run Actions > ci > Run Workflow:

alt text

This will build a docs bundle, and then trigger the pages-build-deployment action afterwards to push changes to the gh-pages branch.

docs.kuadrant.io's People

Contributors

jasonmadigan avatar openshift-merge-bot[bot] avatar maleck13 avatar guicassolato avatar david-martin avatar openshift-merge-robot avatar boomatang avatar alexsnaps avatar openshift-ci[bot] avatar pehala avatar mikenairn avatar ygnas avatar laurafitzgerald avatar pmccarthy avatar r-lawton avatar adam-cattermole avatar ericwittmann avatar sergioifg94 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.