Skip to content

docs: rehaul website #456

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

Merged
merged 27 commits into from
Jul 27, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
04930e9
initiated bundler for jekyll and removed bootstrap
Jul 5, 2021
91052d3
added minimalist library and normalize css
Jul 5, 2021
36b32fe
created responsive navigation bar
Jul 5, 2021
b03d320
removed unused files
Jul 9, 2021
9f2ad75
replaced skeleton with uikit to make it easier for future contributor…
Jul 9, 2021
a8af406
Implemented navigation bar generated from data file
Jul 12, 2021
c3d62fc
Improved navbar
Jul 12, 2021
608e75b
Created Hero section for homepage layout
Jul 12, 2021
ec08bac
Created sponsors section for homepage layout
Jul 12, 2021
9faa424
Improved sponsors section for homepage layout
Jul 13, 2021
7750de0
Improved navigation bar
Jul 13, 2021
c6526ac
Created footer
Jul 13, 2021
ea21a45
Created documentation template and collection of pages
Jul 14, 2021
6bc830b
Created default template and 404 page
Jul 14, 2021
fe2775c
Improved default template and 404 page
Jul 19, 2021
5f505e5
Refactored homepage
Jul 19, 2021
60619fb
Added Code of conduct page
Jul 19, 2021
9531837
Implemented Prism Js for code snippets
Jul 19, 2021
50ecd1c
Fixed broken links
Jul 19, 2021
8b03b13
Implemented Releases page
Jul 20, 2021
1d1cdef
Removed unused index page
Jul 20, 2021
d555b65
Included the sponsors sections in the homepage
Jul 21, 2021
125bc73
Added comments and created a website readme file
Jul 21, 2021
00d8518
Refined style details and removed unused assets
Jul 21, 2021
e176ed8
Removed domain from social links
Jul 21, 2021
919e3dc
Removed left over comments, added submenu example to website readme
Jul 21, 2021
9cb372a
Updated small svg logo
Jul 21, 2021
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/404.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: 404 - page doesn't exist!
description: 404 - are you lost?
layout: default
permalink: /404.html
---

## Sorry, the page you were looking for could not be found.
{:.uk-section .uk-container .uk-text-center}

### Return to our [home page]({{ "/" | relative_url }}), or [contact us](https://discord.gg/DacEhAy) if you can’t find what you are looking for.
{: .uk-container .uk-text-center}
138 changes: 138 additions & 0 deletions docs/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
---
title: Contributor Covenant Code of Conduct
description: Code of Conduct
layout: default
permalink: /coc.html
---

All participants to the Java Operator SDK project are required to comply with
the following code of conduct, which is based on v2.0 of the [Contributor
Covenant](https://www.contributor-covenant.org/).


## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to adam.sandor@container-solutions.com or any of the project admins.

All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series
of actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
8 changes: 8 additions & 0 deletions docs/Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# frozen_string_literal: true

source "https://rubygems.org"

git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }

gem "jekyll", "~> 4.2"
gem "jekyll-github-metadata"
84 changes: 84 additions & 0 deletions docs/Gemfile.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
GEM
remote: https://rubygems.org/
specs:
addressable (2.8.0)
public_suffix (>= 2.0.2, < 5.0)
colorator (1.1.0)
concurrent-ruby (1.1.9)
em-websocket (0.5.2)
eventmachine (>= 0.12.9)
http_parser.rb (~> 0.6.0)
eventmachine (1.2.7)
faraday (1.3.0)
faraday-net_http (~> 1.0)
multipart-post (>= 1.2, < 3)
ruby2_keywords
faraday-net_http (1.0.1)
ffi (1.15.3)
forwardable-extended (2.6.0)
http_parser.rb (0.6.0)
i18n (1.8.10)
concurrent-ruby (~> 1.0)
jekyll (4.2.0)
addressable (~> 2.4)
colorator (~> 1.0)
em-websocket (~> 0.5)
i18n (~> 1.0)
jekyll-sass-converter (~> 2.0)
jekyll-watch (~> 2.0)
kramdown (~> 2.3)
kramdown-parser-gfm (~> 1.0)
liquid (~> 4.0)
mercenary (~> 0.4.0)
pathutil (~> 0.9)
rouge (~> 3.0)
safe_yaml (~> 1.0)
terminal-table (~> 2.0)
jekyll-github-metadata (2.13.0)
jekyll (>= 3.4, < 5.0)
octokit (~> 4.0, != 4.4.0)
jekyll-sass-converter (2.1.0)
sassc (> 2.0.1, < 3.0)
jekyll-watch (2.2.1)
listen (~> 3.0)
kramdown (2.3.1)
rexml
kramdown-parser-gfm (1.1.0)
kramdown (~> 2.0)
liquid (4.0.3)
listen (3.5.1)
rb-fsevent (~> 0.10, >= 0.10.3)
rb-inotify (~> 0.9, >= 0.9.10)
mercenary (0.4.0)
multipart-post (2.1.1)
octokit (4.20.0)
faraday (>= 0.9)
sawyer (~> 0.8.0, >= 0.5.3)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
public_suffix (4.0.6)
rb-fsevent (0.11.0)
rb-inotify (0.10.1)
ffi (~> 1.0)
rexml (3.2.5)
rouge (3.26.0)
ruby2_keywords (0.0.4)
safe_yaml (1.0.5)
sassc (2.4.0)
ffi (~> 1.9)
sawyer (0.8.2)
addressable (>= 2.3.5)
faraday (> 0.8, < 2.0)
terminal-table (2.0.0)
unicode-display_width (~> 1.1, >= 1.1.1)
unicode-display_width (1.7.0)

PLATFORMS
universal-darwin-20

DEPENDENCIES
jekyll (~> 4.2)
jekyll-github-metadata

BUNDLED WITH
2.2.22
23 changes: 20 additions & 3 deletions docs/_config.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,25 @@
---

# Site settings
name: Java Operator SDK
title: Java Operator SDK
title: Java Operator SDK
description: Build Kubernetes Operators in Java without hassle
logo: logo-white.svg
logo-icon: logo-icon.svg
permalink: /:title/
date_format: "%b %-d, %Y"
images: /assets/images/


# Rouge highlighter
markdown: kramdown
highlighter: none

kramdown:
kramdown:
parse_block_html: true
permalink: /:title
permalink: /:title
syntax_highlighter_opts:
disable : true

plugins:
- "jekyll-github-metadata"
19 changes: 19 additions & 0 deletions docs/_data/navbar.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Navbar menu navigation links
- title: Home
url: /
- title: Docs
url: /docs/getting-started
- title: Code of Conduct
url: /coc
- title: Releases
url: /releases
# Navbar buttons or social icons
- title: Join Discord
url: https://discord.gg/DacEhAy
button: default
type: discord
- title: Contribute
url: https://github.com/java-operator-sdk/java-operator-sdk
button: default
type: github

7 changes: 7 additions & 0 deletions docs/_data/sidebar.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Navbar menu navigation links
- title: Getting Started
url: /docs/getting-started
- title: Contributing
url: /docs/contributing
- title: How to use Samples
url: /docs/using-samples
25 changes: 10 additions & 15 deletions docs/_includes/footer.html
Original file line number Diff line number Diff line change
@@ -1,16 +1,11 @@
<div class="footer-strip">
<div class="footer">
<div class="footer-menu">
<ul>
<li><a href="{{ site.baseurl }}/">Home</a></li>
<li><a href="mailto:info@container-solutions.com">Contact Us</a></li>
</ul>
</div>
<div class="footer-title">
Sponsored by
<a href="https://container-solutions.com/" target="_blank" rel="noopener noreferrer">
<img src="{{ site.baseurl }}/assets/images/cs.png">
</a>
</div>
<footer class="uk-section uk-section-secondary uk-text-center uk-text-muted uk-link-muted">
<div class="uk-container uk-container-small">
<ul class="uk-subnav uk-flex-center">
{% for link in site.data.navbar%}
{% include menuItems.html %}
{% endfor %}
</ul>
<p>Released under the <a href="https://github.com/java-operator-sdk/java-operator-sdk/blob/master/LICENSE" target="_blank">Apache License 2.0</a>
<br/>Copyright © 2020 - {{ 'now' | date: "%Y" }} Container Solutions</p>
</div>
</div>
</footer>
21 changes: 0 additions & 21 deletions docs/_includes/header.html

This file was deleted.

20 changes: 20 additions & 0 deletions docs/_includes/hero.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<div class="uk-section uk-background-primary section-hero light repeat: true" style="">
<div class="uk-container uk-text-center ">
{% if site.logo %}
<img src="{{ site.images | absolute_url }}{{ site.logo-icon }}" alt="{{ site.title }}" class="uk-inline uk-logo uk-margin-medium-right" style="width: 5rem;">
{% endif %}
<h1 class="uk-heading-hero uk-text-bold uk-text-uppercase uk-text-muted uk-inline " style="font-family: 'Asap', sans-serif"> [ <small class="uk-margin-small-right uk-margin-small-left"> {{ site.title }} </small> ]</h1>
<div class="links uk-container uk-margin-medium-top">
<a class="uk-button uk-button-small uk-border-pill uk-button-secondary uk-margin-small-bottom" href="{{ domain }}{{ link.url }}">
Get Started
</a>
<a class="uk-button uk-button-small uk-border-pill uk-button-default uk-margin-small-bottom " href="{{ domain }}{{ link.url }}">
<span uk-icon="github"></span> Contribute
</a>
<a class="uk-button uk-button-small uk-border-pill uk-button-default uk-margin-small-bottom" href="{{ domain }}{{ link.url }}">
<span uk-icon="discord"></span> Discord Channel
</a>
</div>
</div>
</div>

5 changes: 5 additions & 0 deletions docs/_includes/heroDefault.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<div class="uk-section uk-background-primary section-hero light repeat: true" style="">
<div class="uk-container uk-text-center ">
<h1 class="uk-heading-hero uk-text-bold uk-text-uppercase uk-text-muted uk-inline " style="font-family: 'Asap', sans-serif"> [ <small class="uk-margin-small-right uk-margin-small-left"> {{ page.title }} </small> ]</h1>
</div>
</div>
2 changes: 1 addition & 1 deletion docs/_includes/links.html
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<link rel="shortcut icon" href="{{ site.baseurl }}/assets/images/favicon.ico" type="image/x-icon">
<link rel="icon" href="{{ site.baseurl }}/assets/images/favicon.ico" type="image/x-icon"><link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic,700,700italic,800,800italic|Exo:100,100italic,200,200italic,300,300italic,400,400italic,500,500italic,600,600italic,700,700italic,800,800italic,900,900italic|Dosis:200,300,regular,500,600,700,800" crossorigin="anonymous">
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css" integrity="sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T" crossorigin="anonymous">
<link rel="stylesheet" href="{{ site.baseurl }}/assets/css/style.css"/>
<link rel="stylesheet" href="{{ site.baseurl }}/assets/css/prism.css"/>
Loading