Commit e056293c authored by CodeDuSoir's avatar CodeDuSoir
Browse files

change the design

parent 4353de7c
Pipeline #366337 failed with stage
in 12 seconds
......@@ -2,7 +2,13 @@ source "https://rubygems.org"
ruby RUBY_VERSION
# This will help ensure the proper Jekyll version is running.
gem "jekyll", "3.4.0"
gem "jekyll", "3.8.3"
group :jekyll_plugins do
gem "jekyll-feed"
gem "jekyll-paginate"
end
# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]
......
GEM
remote: https://rubygems.org/
specs:
addressable (2.5.0)
public_suffix (~> 2.0, >= 2.0.2)
addressable (2.5.2)
public_suffix (>= 2.0.2, < 4.0)
colorator (1.1.0)
ffi (1.9.17)
concurrent-ruby (1.0.5)
em-websocket (0.5.1)
eventmachine (>= 0.12.9)
http_parser.rb (~> 0.6.0)
eventmachine (1.2.7)
ffi (1.9.25)
forwardable-extended (2.6.0)
jekyll (3.4.0)
http_parser.rb (0.6.0)
i18n (0.9.5)
concurrent-ruby (~> 1.0)
jekyll (3.8.3)
addressable (~> 2.4)
colorator (~> 1.0)
em-websocket (~> 0.5)
i18n (~> 0.7)
jekyll-sass-converter (~> 1.0)
jekyll-watch (~> 1.1)
kramdown (~> 1.3)
liquid (~> 3.0)
jekyll-watch (~> 2.0)
kramdown (~> 1.14)
liquid (~> 4.0)
mercenary (~> 0.3.3)
pathutil (~> 0.9)
rouge (~> 1.7)
rouge (>= 1.7, < 4)
safe_yaml (~> 1.0)
jekyll-sass-converter (1.5.0)
jekyll-feed (0.11.0)
jekyll (~> 3.3)
jekyll-paginate (1.1.0)
jekyll-sass-converter (1.5.2)
sass (~> 3.4)
jekyll-watch (1.5.0)
listen (~> 3.0, < 3.1)
kramdown (1.13.2)
liquid (3.0.6)
listen (3.0.8)
jekyll-watch (2.0.0)
listen (~> 3.0)
kramdown (1.17.0)
liquid (4.0.0)
listen (3.1.5)
rb-fsevent (~> 0.9, >= 0.9.4)
rb-inotify (~> 0.9, >= 0.9.7)
ruby_dep (~> 1.2)
mercenary (0.3.6)
pathutil (0.14.0)
pathutil (0.16.1)
forwardable-extended (~> 2.6)
public_suffix (2.0.5)
rb-fsevent (0.9.8)
rb-inotify (0.9.8)
ffi (>= 0.5.0)
rouge (1.11.1)
public_suffix (3.0.3)
rb-fsevent (0.10.3)
rb-inotify (0.9.10)
ffi (>= 0.5.0, < 2)
rouge (3.2.1)
ruby_dep (1.5.0)
safe_yaml (1.0.4)
sass (3.4.23)
sass (3.5.7)
sass-listen (~> 4.0.0)
sass-listen (4.0.0)
rb-fsevent (~> 0.9, >= 0.9.4)
rb-inotify (~> 0.9, >= 0.9.7)
PLATFORMS
ruby
DEPENDENCIES
jekyll (= 3.4.0)
jekyll (= 3.8.3)
jekyll-feed
jekyll-paginate
tzinfo-data
RUBY VERSION
ruby 2.3.1p112
ruby 2.7.1p83
BUNDLED WITH
1.13.6
2.1.4
This diff is collapsed.
![Build Status](https://gitlab.com/pages/jekyll/badges/master/build.svg)
![Build Status](https://gitlab.com/opendatahub/opendatahub.io/badges/master/build.svg)
![Jekyll Version](https://img.shields.io/gem/v/jekyll.svg)
---
Example [Jekyll] website using GitLab Pages. View it live at https://pages.gitlab.io/jekyll
# OpenDataHub.io Website
[Learn more about GitLab Pages](https://pages.gitlab.io) or read the the [official GitLab Pages documentation](https://docs.gitlab.com/ce/user/project/pages/).
## Creating an Inline Announcement
---
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*
All announcements are located in the `_posts` directory. They are written in Markdown (`.md`). Files should be named `YYYY-MM-DD-unique-title`.
- [Getting Started](#getting-started)
- [Start by forking this repository](#start-by-forking-this-repository)
- [Start from a local Jekyll project](#start-from-a-local-jekyll-project)
- [GitLab CI](#gitlab-ci)
- [Using Jekyll locally](#using-jekyll-locally)
- [GitLab User or Group Pages](#gitlab-user-or-group-pages)
- [Did you fork this project?](#did-you-fork-this-project)
- [Other examples](#other-examples)
- [Troubleshooting](#troubleshooting)
Announcements will display all content on the news page. Unlike blog posts, be sure to omit `layout` and `preview` fields.
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
## Getting Started
You can get started with GitLab Pages using Jekyll easily by either forking this repository or by uploading a new/existing Jekyll project.
```jekyll
---
author: yourusername
title: Sample Announcement
date: 2018-09-09
categories: announcement
---
Remember you need to wait for your site to build before you will be able to see your changes. You can track the build on the **Pipelines** tab.
Content goes here and will be shown directly on the news list.
```
### Start by forking this repository
## Creating a Blog Post
1. Fork this repository.
1. **IMPORTANT:** Remove the fork relationship.
Go to **Settings (⚙)** > **Edit Project** and click the **"Remove fork relationship"** button.
1. Enable Shared Runners.
Go to **Settings (⚙)** > **Pipelines** and click the **"Enable shared Runners"** button.
1. Rename the repository to match the name you want for your site.
1. Edit your website through GitLab or clone the repository and push your changes.
All blog posts are located in the `/_posts` directory. Each file is a Markdown (`.md`) file, just like announcements. Files should be named `YYYY-MM-DD-unique-title`.
### Start from a local Jekyll project
Instead of showing all content on the news list, they will have a preview field which is shown. Content will be shown on the blog post detail page. The `preview` page is required or else the entire content of the blog post will be displayed on the news list. The `layout` is required to display properly when clicked.
1. [Install][] Jekyll.
1. Use `jekyll new` to create a new Jekyll Project.
1. Add [this `.gitlab-ci.yml`](.gitlab-ci.yml) to the root of your project.
1. Push your repository and changes to GitLab.
```jekyll
---
layout: blog
author: yourusername
title: Sample Blog Post
preview: Preview text is required. It is shown on the news list instead of the full content.
date: 2018-09-10
categories: blog
---
# Content goes here
## GitLab CI
This content is NOT shown on the news list, but will be shown on the detail page. To reach the detail page, the user will click on the "Read more..." link which is automatically generated.
This project's static Pages are built by [GitLab CI][ci], following the steps
defined in [`.gitlab-ci.yml`](.gitlab-ci.yml):
## More stuff...
```
image: ruby:2.3
variables:
JEKYLL_ENV: production
pages:
script:
- bundle install
- bundle exec jekyll build -d public
artifacts:
paths:
- public
only:
- master
```
## Using Jekyll locally
## Create a Page
To work locally with this project, you'll have to follow the steps below:
To keep things organized, pages are located in the `pages` directory, with a directory structure mirroring the site. Configure the metadata:
1. Fork, clone or download this project
1. [Install][] Jekyll
1. Download dependencies: `bundle`
1. Build and preview: `bundle exec jekyll serve`
1. Add content
```jekyll
---
layout: default
title: My Page
permalink: /my-page/
---
```
The above commands should be executed from the root directory of this project.
If you add a new page and want it to appear in the sidebar of that section (such as the sidebar under **Docs**), then you also need to update the `yaml` file associated with that group. These are located under `_data/`. For **Docs**, you would update `docs_toc.yml`, following the structure that currently exists within that file.
Read more at Jekyll's [documentation][].
## GitLab User or Group Pages
## Links
To use this project as your user/group website, you will need one additional
step: just rename your project to `namespace.gitlab.io`, where `namespace` is
your `username` or `groupname`. This can be done by navigating to your
project's **Settings**.
Links should prepend `site.baseurl` before the location. e.g.:
Read more about [user/group Pages][userpages] and [project Pages][projpages].
```jekyll
<link href="{{ '/assets/css/home.css' | prepend: site.baseurl }}" rel="stylesheet">
<img src="{{ '/assets/img/datahub_logo_black.png' | prepend: site.baseurl }}">
<a class="nav-link" href="{{ '/news/' | prepend: site.baseurl }}">NEWS</a>
```
## Did you fork this project?
## Local testing
If you forked this project for your own use, please go to your project's
**Settings** and remove the forking relationship, which won't be necessary
unless you want to contribute back to the upstream project.
You can run the site just like any other Jekyll site as [documented](https://jekyllrb.com/docs/) or using a [jekyll container](https://store.docker.com/community/images/jekyll/jekyll).
## Other examples
### Running a jekyll container on linux using docker
You can view the local changes to your clone of the opendatahub.io in realtime by running the jekyll server in a docker container. You'll be running the container with a volume mounted to the root of your opendatahub.io repository.
From the root of your cloned opendatahub.io repository:
* [jekyll-branched](https://gitlab.com/pages/jekyll-branched) demonstrates how you can keep your GitLab Pages site in one branch and your project's source code in another.
* The [jekyll-themes](https://gitlab.com/groups/jekyll-themes) group contains a collection of example projects you can fork (like this one) having different visual styles.
```bash
# To prevent SELinux from denying docker from mounting your repository folder as a volume You'll need to change the selinux context for the root of the opendatahub.io repository directory
chcon -Rt svirt_sandbox_file_t $PWD
## Troubleshooting
# Set an environment variable for the version of the jekyll container
export JEKYLL_VERSION=3.8
1. CSS is missing! That means two things:
* Either that you have wrongly set up the CSS URL in your templates, or
* your static generator has a configuration option that needs to be explicitly
set in order to serve static assets under a relative URL.
# Run the jekyll container, map the container port 4000 to the host port 4000 and set the environment variable JEKYLL_UID to your user ID to prevent any permission issues with adding or modifying files
# If you're concerned about the container user running with the same user ID, you can modify the permission of the repo folder to allow read/write access to other
docker run --rm --volume="/home/llasmith/projects/data-hub/opendatahub.io:/srv/jekyll" -it -p 4000:4000 -e JEKYLL_UID=$(id -u) jekyll/jekyll:$JEKYLL_VERSION jekyll serve
[ci]: https://about.gitlab.com/gitlab-ci/
[Jekyll]: http://jekyllrb.com/
[install]: https://jekyllrb.com/docs/installation/
[documentation]: https://jekyllrb.com/docs/home/
[userpages]: https://docs.gitlab.com/ce/user/project/pages/introduction.html#user-or-group-pages
[projpages]: https://docs.gitlab.com/ce/user/project/pages/introduction.html#project-pages
```
......@@ -6,21 +6,29 @@
# 'jekyll serve'. If you change this file, please restart the server process.
# Site settings
title: Example Jekyll site using GitLab Pages
email: your-email@domain.com
description: > # this means to ignore newlines until "baseurl:"
Write an awesome description for your new site here. You can edit this
line in _config.yml. It will appear in your document head meta (for
Google search results) and in your feed.xml site description.
baseurl: "" # the subpath of your site, e.g. /blog
title: Toobib
email: interhop@riseup.org
description: >
Toobib - L'annuaire des praticiens de santé
#baseurl: "/" # the subpath of your site, e.g. /blog
url: "https://toobib.org" # the base hostname & protocol for your site
twitter_username: jekyllrb
github_username: jekyll
gitlab_username: pages
# Outputting
permalink: /:categories/:year/:month/:day/:title
repo: https://framagit.org/interhop/toobib/single-page
email_list:
#twitter_username: aicoe
#github_username: aicoe
# Build settings
markdown: kramdown
exclude: ["README.md"]
\ No newline at end of file
kramdown:
input: GFM
syntax_highlighter: rouge
permalink: /news/:year-:month-:day/:title:output_ext
plugins:
- jekyll-feed
exclude:
- design
- "README.md"
- .idea
toc:
- title: Abstract
url: /arch.html#abstract
- title: Comments and Feedback
url: /arch.html#comments-and-feedback
- title: Executive Summary
url: /arch.html#executive-summary
- title: High Level Architecture
url: /arch.html#ai-as-service-high-level-architecture
- title: Open Data Hub Platform
url: /arch.html#open-data-hub-platform
children:
- title: Components and Considerations
url: /arch.html#components-and-considerations
children:
- title: End to End Considerations
url: /arch.html#end-to-end-considerations
- title: Included Components
url: /arch.html#current-included-components
- title: Roadmap
url: /arch.html#roadmap
- title: Community
url: /arch.html#community
- title: Deploying
url: /arch.html#deploying-open-data-hub-core-components
children:
- title: Pre-requisites
url: /arch.html#pre-requisites
- title: Installation
url: /arch.html#installation
children:
- title: Ceph with Rook
url: /arch.html#ceph-installation-with-the-rook-operator
- title: Manual Installation
url: /arch.html#option-1-odh-manual-installation
- title: Operator Lifecycle Manager
url: /arch.html#option-2-odh-installation-via-the-operator-lifecycle-manager-olm-catalog
- title: Getting Started
url: /arch.html#getting-started
- title: Operational Management
url: /arch.html#operational-management
children:
- title: Description
url: /arch.html#description
- title: Installation and Setup
url: /arch.html#installation-and-setup
- title: Alerting and Dashboarding
url: /arch.html#alerting-and-dashboarding
- title: AI Library
url: /arch.html#ai-library
children:
- title: Description
url: /arch.html#description-1
- title: Installation
url: /arch.html#installation-1
- title: Available Models
url: /arch.html#available-models
- title: Conclusion
url: /arch.html#conclusion
- title: Contributers
url: /arch.html#ai-library
- title: Legal Notice
url: /arch.html#legal-notice
toc:
- title: Introduction
url: /docs.html
- title: Getting Started
url: /docs/getting-started/quick-installation.html
phony: true
children:
- title: Quick Installation
url: /docs/getting-started/quick-installation.html
- title: Basic Tutorial
url: /docs/getting-started/basic-tutorial.html
- title: Legacy
children:
- title: Quick Installation
url: /docs/getting-started/legacy/quick-installation.html
- title: Basic Tutorial
url: /docs/getting-started/legacy/basic-tutorial.html
- title: Advanced Tutorials
url: /docs/advanced-tutorials/data-exploration.html
phony: true
children:
# - title: JupyterHub
# url: /docs/advanced-tutorials/jupyterhub.html
# - title: HDFS Data
# url: /docs/advanced-tutorials/hdfs.html
# - title: Data Warehouses
# url: /docs/advanced-tutorials/warehouse.html
# - title: Ceph
# url: /docs/advanced-tutorials/ceph.html
# - title: Spark
# url: /docs/advanced-tutorials/spark.html
# - title: Seldon
# url: /docs/advanced-tutorials/seldon.html
# - title: Argo
# url: /docs/advanced-tutorials/argo.html
- title: Data Exploration
url: /docs/advanced-tutorials/data-exploration.html
# - title: Kafka
# url: /docs/advanced-tutorials/kafka.html
# - title: Combined
# url: /docs/advanced-tutorials/combined.html
# Uncomment when Kubeflow docs are ready
- title: Kubeflow
url: /docs/kubeflow.html
phony: true
children:
- title: Overview
url: /docs/kubeflow.html
- title: Installation
url: /docs/kubeflow/installation.html
- title: Combining components
url: /docs/kubeflow/mixing.html
# - title: Components
# url: /docs/kubeflow/components/jupyter.html
# phony: true
# children:
# - title: Jupyter Notebooks
# url: /docs/kubeflow/components/jupyter.html
# - title: Hyperparameter Tuning
# url: /docs/kubeflow/components/hyperparameter.html
# - title: Pipelines
# url: /docs/kubeflow/components/pipelines.html
# - title: Serving
# url: /docs/kubeflow/components/serving.html
# - title: Training
# url: /docs/kubeflow/components/training.html
# - title: Miscellaneous
# url: /docs/kubeflow/components/misc.html
- title: AI Library
url: /docs/ai-library.html
phony: true
children:
- title: Overview
url: /docs/ai-library.html
- title: Installation
url: /docs/ai-library/installation.html
- title: Services
url: /docs/ai-library/services.html
# - title: Custom Models
# url: /docs/ai-library/custom-models.html
# - title: API
# url: /docs/ai-library/api.html
- title: Administration
url: /docs/administration/installation-customization/customization.html
phony: true
children:
- title: Customizing Installation
url: /docs/administration/installation-customization/customization.html
phony: true
- title: Advanced Installation
url: /docs/administration/advanced-installation/optional.html
phony: true
children:
- title: Optional Components
url: /docs/administration/advanced-installation/optional.html
- title: Object Storage
url: /docs/administration/advanced-installation/object-storage.html
- title: GPU Enablement
url: /docs/administration/advanced-installation/gpu.html
# - title: Upgrading
# url: /docs/administration/upgrading.html
# - title: Monitoring
# url: /docs/administration/monitoring.html
# - title: Security
# url: /docs/administration/security.html
# - title: Troubleshooting
# url: /docs/administration/troubleshooting.html
- title: Architecture
url: /docs/architecture.html
phony: true
children:
- title: Technology Landscape
url: /docs/landscape.html
phony: true
- title: Roadmap
url: /docs/roadmap/future.html
phony: true
children:
- title: Future
url: /docs/roadmap/future.html
- title: Release Notes
url: /docs/roadmap/release-notes.html
- title: Additional Resources
url: /docs/additional.html
children:
- title: Community
url: /docs/additional.html#community
- title: Videos
url: /docs/additional.html#videos
- title: Audio
url: /docs/additional.html#audio
# - title: FAQ
# url: /docs/faq.html
future:
- title: Open Data Hub 0.8 - end of August 2020
children:
- title: ODH JupyterHub
description: Forked JupyterHub repos under Open Data Hub github repo for maintaining new changes. Added notebook images to Thoth Station for building. Added ability to launch JupyterLab images.
- title: Notebooks to Pipelines with Elyra
description: Added a JupyterLab notebook image that includes Elyra. Elyra converts notebooks to Argo or Kubeflow pipelines.
- title: Mixing ODH & KF components- Distributed Training
description: Added Pytorch operator to work with Open Data Hub components.
- title: Mixing ODH & KF components- Kubeflow Monitoring
description: Added monitoring to Kubeflow components by enabling monitoring to Argo and adding Prometheus and Grafana to Kubeflow installation.
- title: CI/CD
description: Added more tests to Open Data Hub components including Kafka and Superset and enhanced JupyterHub testing by adding Selenium for web portal testing
- title: Open Data Hub 0.9 - End of October 2020
children:
- title: Kubeflow 1.1
description: Add Kubeflow 1.1 to Open Data Hub installation and investigate migrating to Kustomize 3.0
- title: Disconnected Deployment
description: Investigate and introduce ability to deploy ODH on disconnected OpenShift clusters.
- title: UBI based KF
description: Continuation of the "UBI based ODH" expanding to Kubeflow project and looking at what does it take to move Kubeflow components to UBI.
- title: CI/CD
description: Continuation of the of the effort to design and create a complete CI/CD process.
- title: Object Storage
description: Add an Object Storage tool based on Rook-Ceph
- title: Enable Monitoring
description: Continuation of the effort to enable Prometheus enpoints in all Open Data Hub and Kubeflow components.
- title: Open Data Hub Dashboard
description: Team is currently creating an Open Data Hub dashboard that will be the entry point to all installed components.
- title: Open Data Hub 1.0 - TBD
children:
- title: ODH Data Catalog
description: Migrate Open Data Hub Data Catalog component from Ansible to Kustomize.
- title: ODH Istio/Service Mesh
description: Add istio/Service Mesh to Open Data Hub.
- title: Kubeflow KFServing
description: Enable KFServing in Open Data Hub.
- title: Kubeflow Pipelines on Tekton
description: Enable Kubeflow Pipelines using Tekton in Open Data Hub.
past:
- title: Open Data Hub 0.7 - end of June 2020
children:
- title: KF 1.0 on OpenShift
description: The main goal of this initiative is to verify Kubeflow 1.0 works on OpenShift and fix the issues we find. Another goal is to document and ideally automate some of the verification process to start enabling the CI for KF on OpenSHift.
- title: CI improvements
description: Extending tests for all components, enabling CI for the operator repository.
- title: Mixing ODH & KF components (start)
description: Proving users can mix ODH and KF components, compiling a prioritized list of components to be verified and fixed, proving on the first component (probably TF Job or Pytorch Job)
- title: Add Object Storage Component
description: Since ODH relies on S3 compatible object storage, add dependency on some minimal install of OpenShift Container Storage.
- title: Convert Data Catalog to Kustomize
description: Data Catalog is the last component missing the conversion to Kustomize.
- title: Open Data Hub 0.6 - end of April 2020
children:
- title: Rebase ODH on KF operator
description: Use Kubeflow operator as a base for ODH.
- title: Convert ODH components to Kustomize
description: Convert all ODH components to Kustomize to match Kubeflow deployment tooling.
- title: Start CI for ODH
description: Investicate and kickstart ODH CI based on OpenShift CI
- title: Move to Github
description: Since the goal of this release is to get closer to KF community, we need to move to Github
- title: Add Apache Airflow
description: Add Apache Airflow as a component into Open Data Hub
\ No newline at end of file
{% if site.data.arch_toc.toc[0] %}
{% for item in site.data.arch_toc.toc %}
{% if item.phony != true and page.url == item.url%}
<h4 class="arch-nav-item active">
{% else %}
<h4 class="arch-nav-item">
{% endif %}
<a href="{{ site.baseurl }}{{ item.url }}">{{ item.title }}</a>
</h4>
{% if item.children[0] %}
{% for child in item.children %}
{% if child.phony != true and page.url == child.url %}
<h5 class="arch-nav-sub-item active">
{% else %}
<h5 class="arch-nav-sub-item">
{% endif %}
<a href="{{ site.baseurl }}{{ child.url }}">
{{ child.title }}
</a>
</h5>
{% if child.children[0] %}
{% for grandchild in child.children %}
{% if grandchild.phony != true and page.url == grandchild.url %}
<h6 class="arch-nav-sub3-item active">
{% else %}
<h6 class="arch-nav-sub3-item">