GithubHelp home page GithubHelp logo

alexcreasy / odh-dashboard Goto Github PK

View Code? Open in Web Editor NEW

This project forked from opendatahub-io/odh-dashboard

0.0 1.0 0.0 22.27 MB

Dashboard for ODH

License: Apache License 2.0

Shell 0.12% JavaScript 1.81% TypeScript 96.76% Makefile 0.08% HTML 0.02% Dockerfile 0.09% SCSS 1.12%

odh-dashboard's Introduction

Open Data Hub Dashboard

A dashboard for Open Data Hub components.

  • Shows what's installed
  • Show's what's available for installation
  • Links to component UIs
  • Links to component documentation

Requirements

ODH requires the following to run:

Additional tooling requirements

Development

  1. Clone the repository

    git clone https://github.com/opendatahub-io/odh-dashboard
  2. Within the repo context, install project dependencies

    cd odh-dashboard && npm install

Build project

npm run build

Serve development content

This is the default context for running a local UI. Make sure you build the project using the instructions above prior to running the command below.

npm run start

For in-depth local run guidance review the contribution guidelines.

Testing

Run the tests.

npm run test

Run storybook a11y tests and interaction tests.

npm run storybook
npm run test:storybook

For in-depth testing guidance review the contribution guidelines

Deploying the ODH Dashbard

Official Image Builds

odh-dashboard images are automatically built and pushed to quay.io after every commit to the main branch. The image tag name format for each image is main-<COMMIT SHORT HASH>.

Example: The main branch is updated with commit f76e3952834f453b1d085e8627f9c17297c2f64c. The CI system will automatically build an odh-dashboard image based on that code and push the new image to odh-dashboard:main-f76e395 and updated odh-dashboard:main to point to the same image hash.

The nightly tag is a floating tag that is updated nightly and points to the most recent main-<HASH> commit from the previous day.

Deploy using kustomize

The manifests folder contains a kustomize manifest that can be used with kustomize build.

Deploy using a kfdef

The manifests/kfdef folder contains an example kfdef to deploy ODH Dashboard with the Notebook Controller backend is located in odh-dashboard-kfnbc-test.yaml.

Contributing

Contributing encompasses repository specific requirements.

Triaging

For information on how we triage tickets, see our triage.md.

Documentation

You can find more information about this project in the document section.

Releases

For more information on how, when, and what we do for releases, see our releases.md.

odh-dashboard's People

Contributors

jeff-phillips-18 avatar andrewballantyne avatar daodaonocode avatar lucferbux avatar openshift-merge-robot avatar gkrumbach07 avatar maroroman avatar dependabot[bot] avatar cfchase avatar lavlas avatar dlabaj avatar mlassak avatar manaswinidas avatar jenny-s51 avatar pnaik1 avatar taneem-ibrahim avatar parthsoni95 avatar cdcabrera avatar tumido avatar uidoyen avatar christianvogt avatar albertdefusco avatar strangiato avatar vaishnavihire avatar accorvin avatar alexcreasy avatar zdtsw avatar tmckayus avatar shalberd avatar xaenalt avatar

Watchers

 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.