Skip to content

Commit c6f6d8e

Browse files
loredanamoangaloredanamoanga
authored
docs: rehaul website (#456)
* initiated bundler for jekyll and removed bootstrap * added minimalist library and normalize css * created responsive navigation bar * removed unused files * replaced skeleton with uikit to make it easier for future contributors to create new pages and elements * Implemented navigation bar generated from data file * Improved navbar * Created Hero section for homepage layout * Created sponsors section for homepage layout * Improved sponsors section for homepage layout * Improved navigation bar * Created footer * Created documentation template and collection of pages * Created default template and 404 page * Improved default template and 404 page * Refactored homepage * Added Code of conduct page * Implemented Prism Js for code snippets * Fixed broken links * Implemented Releases page * Removed unused index page * Included the sponsors sections in the homepage * Added comments and created a website readme file * Refined style details and removed unused assets * Removed domain from social links * Removed left over comments, added submenu example to website readme * Updated small svg logo
1 parent c7e9d72 commit c6f6d8e

File tree

205 files changed

+37805
-155
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

205 files changed

+37805
-155
lines changed

‎docs/404.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: 404 - page doesn't exist!
3+
description: 404 - are you lost?
4+
layout: default
5+
permalink: /404.html
6+
---
7+
8+
## Sorry, the page you were looking for could not be found.
9+
{:.uk-section .uk-container .uk-text-center}
10+
11+
### Return to our [home page]({{ "/" | relative_url }}), or [contact us](https://discord.gg/DacEhAy) if you can’t find what you are looking for.
12+
{: .uk-container .uk-text-center}

‎docs/CODE_OF_CONDUCT.md

Lines changed: 138 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
1+
---
2+
title: Contributor Covenant Code of Conduct
3+
description: Code of Conduct
4+
layout: default
5+
permalink: /coc.html
6+
---
7+
8+
All participants to the Java Operator SDK project are required to comply with
9+
the following code of conduct, which is based on v2.0 of the [Contributor
10+
Covenant](https://www.contributor-covenant.org/).
11+
12+
13+
## Our Pledge
14+
15+
We as members, contributors, and leaders pledge to make participation in our
16+
community a harassment-free experience for everyone, regardless of age, body
17+
size, visible or invisible disability, ethnicity, sex characteristics, gender
18+
identity and expression, level of experience, education, socio-economic status,
19+
nationality, personal appearance, race, religion, or sexual identity
20+
and orientation.
21+
22+
We pledge to act and interact in ways that contribute to an open, welcoming,
23+
diverse, inclusive, and healthy community.
24+
25+
## Our Standards
26+
27+
Examples of behavior that contributes to a positive environment for our
28+
community include:
29+
30+
* Demonstrating empathy and kindness toward other people
31+
* Being respectful of differing opinions, viewpoints, and experiences
32+
* Giving and gracefully accepting constructive feedback
33+
* Accepting responsibility and apologizing to those affected by our mistakes,
34+
and learning from the experience
35+
* Focusing on what is best not just for us as individuals, but for the
36+
overall community
37+
38+
Examples of unacceptable behavior include:
39+
40+
* The use of sexualized language or imagery, and sexual attention or
41+
advances of any kind
42+
* Trolling, insulting or derogatory comments, and personal or political attacks
43+
* Public or private harassment
44+
* Publishing others' private information, such as a physical or email
45+
address, without their explicit permission
46+
* Other conduct which could reasonably be considered inappropriate in a
47+
professional setting
48+
49+
## Enforcement Responsibilities
50+
51+
Community leaders are responsible for clarifying and enforcing our standards of
52+
acceptable behavior and will take appropriate and fair corrective action in
53+
response to any behavior that they deem inappropriate, threatening, offensive,
54+
or harmful.
55+
56+
Community leaders have the right and responsibility to remove, edit, or reject
57+
comments, commits, code, wiki edits, issues, and other contributions that are
58+
not aligned to this Code of Conduct, and will communicate reasons for moderation
59+
decisions when appropriate.
60+
61+
## Scope
62+
63+
This Code of Conduct applies within all community spaces, and also applies when
64+
an individual is officially representing the community in public spaces.
65+
Examples of representing our community include using an official e-mail address,
66+
posting via an official social media account, or acting as an appointed
67+
representative at an online or offline event.
68+
69+
## Enforcement
70+
71+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
72+
reported to [email protected] or any of the project admins.
73+
74+
All complaints will be reviewed and investigated promptly and fairly.
75+
76+
All community leaders are obligated to respect the privacy and security of the
77+
reporter of any incident.
78+
79+
## Enforcement Guidelines
80+
81+
Community leaders will follow these Community Impact Guidelines in determining
82+
the consequences for any action they deem in violation of this Code of Conduct:
83+
84+
### 1. Correction
85+
86+
**Community Impact**: Use of inappropriate language or other behavior deemed
87+
unprofessional or unwelcome in the community.
88+
89+
**Consequence**: A private, written warning from community leaders, providing
90+
clarity around the nature of the violation and an explanation of why the
91+
behavior was inappropriate. A public apology may be requested.
92+
93+
### 2. Warning
94+
95+
**Community Impact**: A violation through a single incident or series
96+
of actions.
97+
98+
**Consequence**: A warning with consequences for continued behavior. No
99+
interaction with the people involved, including unsolicited interaction with
100+
those enforcing the Code of Conduct, for a specified period of time. This
101+
includes avoiding interactions in community spaces as well as external channels
102+
like social media. Violating these terms may lead to a temporary or
103+
permanent ban.
104+
105+
### 3. Temporary Ban
106+
107+
**Community Impact**: A serious violation of community standards, including
108+
sustained inappropriate behavior.
109+
110+
**Consequence**: A temporary ban from any sort of interaction or public
111+
communication with the community for a specified period of time. No public or
112+
private interaction with the people involved, including unsolicited interaction
113+
with those enforcing the Code of Conduct, is allowed during this period.
114+
Violating these terms may lead to a permanent ban.
115+
116+
### 4. Permanent Ban
117+
118+
**Community Impact**: Demonstrating a pattern of violation of community
119+
standards, including sustained inappropriate behavior, harassment of an
120+
individual, or aggression toward or disparagement of classes of individuals.
121+
122+
**Consequence**: A permanent ban from any sort of public interaction within
123+
the community.
124+
125+
## Attribution
126+
127+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
128+
version 2.0, available at
129+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
130+
131+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
132+
enforcement ladder](https://github.com/mozilla/diversity).
133+
134+
[homepage]: https://www.contributor-covenant.org
135+
136+
For answers to common questions about this code of conduct, see the FAQ at
137+
https://www.contributor-covenant.org/faq. Translations are available at
138+
https://www.contributor-covenant.org/translations.

‎docs/Gemfile

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# frozen_string_literal: true
2+
3+
source "https://rubygems.org"
4+
5+
git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
6+
7+
gem "jekyll", "~> 4.2"
8+
gem "jekyll-github-metadata"

‎docs/Gemfile.lock

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
GEM
2+
remote: https://rubygems.org/
3+
specs:
4+
addressable (2.8.0)
5+
public_suffix (>= 2.0.2, < 5.0)
6+
colorator (1.1.0)
7+
concurrent-ruby (1.1.9)
8+
em-websocket (0.5.2)
9+
eventmachine (>= 0.12.9)
10+
http_parser.rb (~> 0.6.0)
11+
eventmachine (1.2.7)
12+
faraday (1.3.0)
13+
faraday-net_http (~> 1.0)
14+
multipart-post (>= 1.2, < 3)
15+
ruby2_keywords
16+
faraday-net_http (1.0.1)
17+
ffi (1.15.3)
18+
forwardable-extended (2.6.0)
19+
http_parser.rb (0.6.0)
20+
i18n (1.8.10)
21+
concurrent-ruby (~> 1.0)
22+
jekyll (4.2.0)
23+
addressable (~> 2.4)
24+
colorator (~> 1.0)
25+
em-websocket (~> 0.5)
26+
i18n (~> 1.0)
27+
jekyll-sass-converter (~> 2.0)
28+
jekyll-watch (~> 2.0)
29+
kramdown (~> 2.3)
30+
kramdown-parser-gfm (~> 1.0)
31+
liquid (~> 4.0)
32+
mercenary (~> 0.4.0)
33+
pathutil (~> 0.9)
34+
rouge (~> 3.0)
35+
safe_yaml (~> 1.0)
36+
terminal-table (~> 2.0)
37+
jekyll-github-metadata (2.13.0)
38+
jekyll (>= 3.4, < 5.0)
39+
octokit (~> 4.0, != 4.4.0)
40+
jekyll-sass-converter (2.1.0)
41+
sassc (> 2.0.1, < 3.0)
42+
jekyll-watch (2.2.1)
43+
listen (~> 3.0)
44+
kramdown (2.3.1)
45+
rexml
46+
kramdown-parser-gfm (1.1.0)
47+
kramdown (~> 2.0)
48+
liquid (4.0.3)
49+
listen (3.5.1)
50+
rb-fsevent (~> 0.10, >= 0.10.3)
51+
rb-inotify (~> 0.9, >= 0.9.10)
52+
mercenary (0.4.0)
53+
multipart-post (2.1.1)
54+
octokit (4.20.0)
55+
faraday (>= 0.9)
56+
sawyer (~> 0.8.0, >= 0.5.3)
57+
pathutil (0.16.2)
58+
forwardable-extended (~> 2.6)
59+
public_suffix (4.0.6)
60+
rb-fsevent (0.11.0)
61+
rb-inotify (0.10.1)
62+
ffi (~> 1.0)
63+
rexml (3.2.5)
64+
rouge (3.26.0)
65+
ruby2_keywords (0.0.4)
66+
safe_yaml (1.0.5)
67+
sassc (2.4.0)
68+
ffi (~> 1.9)
69+
sawyer (0.8.2)
70+
addressable (>= 2.3.5)
71+
faraday (> 0.8, < 2.0)
72+
terminal-table (2.0.0)
73+
unicode-display_width (~> 1.1, >= 1.1.1)
74+
unicode-display_width (1.7.0)
75+
76+
PLATFORMS
77+
universal-darwin-20
78+
79+
DEPENDENCIES
80+
jekyll (~> 4.2)
81+
jekyll-github-metadata
82+
83+
BUNDLED WITH
84+
2.2.22

‎docs/_config.yml

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,25 @@
11
---
2+
3+
# Site settings
24
name: Java Operator SDK
3-
title: Java Operator SDK
5+
title: Java Operator SDK
6+
description: Build Kubernetes Operators in Java without hassle
7+
logo: logo-white.svg
8+
logo-icon: logo-icon.svg
9+
permalink: /:title/
10+
date_format: "%b %-d, %Y"
11+
images: /assets/images/
12+
13+
14+
# Rouge highlighter
15+
markdown: kramdown
16+
highlighter: none
417

5-
kramdown:
18+
kramdown:
619
parse_block_html: true
7-
permalink: /:title
20+
permalink: /:title
21+
syntax_highlighter_opts:
22+
disable : true
823

24+
plugins:
25+
- "jekyll-github-metadata"

‎docs/_data/navbar.yml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Navbar menu navigation links
2+
- title: Home
3+
url: /
4+
- title: Docs
5+
url: /docs/getting-started
6+
- title: Code of Conduct
7+
url: /coc
8+
- title: Releases
9+
url: /releases
10+
# Navbar buttons or social icons
11+
- title: Join Discord
12+
url: https://discord.gg/DacEhAy
13+
button: default
14+
type: discord
15+
- title: Contribute
16+
url: https://github.com/java-operator-sdk/java-operator-sdk
17+
button: default
18+
type: github
19+

‎docs/_data/sidebar.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Navbar menu navigation links
2+
- title: Getting Started
3+
url: /docs/getting-started
4+
- title: Contributing
5+
url: /docs/contributing
6+
- title: How to use Samples
7+
url: /docs/using-samples

‎docs/_includes/footer.html

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,11 @@
1-
<div class="footer-strip">
2-
<div class="footer">
3-
<div class="footer-menu">
4-
<ul>
5-
<li><a href="{{ site.baseurl }}/">Home</a></li>
6-
<li><a href="mailto:[email protected]">Contact Us</a></li>
7-
</ul>
8-
</div>
9-
<div class="footer-title">
10-
Sponsored by
11-
<a href="https://container-solutions.com/" target="_blank" rel="noopener noreferrer">
12-
<img src="{{ site.baseurl }}/assets/images/cs.png">
13-
</a>
14-
</div>
1+
<footer class="uk-section uk-section-secondary uk-text-center uk-text-muted uk-link-muted">
2+
<div class="uk-container uk-container-small">
3+
<ul class="uk-subnav uk-flex-center">
4+
{% for link in site.data.navbar%}
5+
{% include menuItems.html %}
6+
{% endfor %}
7+
</ul>
8+
<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>
9+
<br/>Copyright © 2020 - {{ 'now' | date: "%Y" }} Container Solutions</p>
1510
</div>
16-
</div>
11+
</footer>

‎docs/_includes/header.html

Lines changed: 0 additions & 21 deletions
This file was deleted.

‎docs/_includes/hero.html

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<div class="uk-section uk-background-primary section-hero light repeat: true" style="">
2+
<div class="uk-container uk-text-center ">
3+
{% if site.logo %}
4+
<img src="{{ site.images | absolute_url }}{{ site.logo-icon }}" alt="{{ site.title }}" class="uk-inline uk-logo uk-margin-medium-right" style="width: 5rem;">
5+
{% endif %}
6+
<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>
7+
<div class="links uk-container uk-margin-medium-top">
8+
<a class="uk-button uk-button-small uk-border-pill uk-button-secondary uk-margin-small-bottom" href="{{ domain }}{{ link.url }}">
9+
Get Started
10+
</a>
11+
<a class="uk-button uk-button-small uk-border-pill uk-button-default uk-margin-small-bottom " href="{{ domain }}{{ link.url }}">
12+
<span uk-icon="github"></span> Contribute
13+
</a>
14+
<a class="uk-button uk-button-small uk-border-pill uk-button-default uk-margin-small-bottom" href="{{ domain }}{{ link.url }}">
15+
<span uk-icon="discord"></span> Discord Channel
16+
</a>
17+
</div>
18+
</div>
19+
</div>
20+

‎docs/_includes/heroDefault.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<div class="uk-section uk-background-primary section-hero light repeat: true" style="">
2+
<div class="uk-container uk-text-center ">
3+
<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>
4+
</div>
5+
</div>

‎docs/_includes/links.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
<link rel="shortcut icon" href="{{ site.baseurl }}/assets/images/favicon.ico" type="image/x-icon">
22
<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">
3-
<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">
43
<link rel="stylesheet" href="{{ site.baseurl }}/assets/css/style.css"/>
4+
<link rel="stylesheet" href="{{ site.baseurl }}/assets/css/prism.css"/>

0 commit comments

Comments
 (0)