Docs: minor fixes (#632)

* Fix descriptions of major releases

* Update meta links 'create documentation issue' link to use new docs issue template

* Update meta links 'create project issue' link to open issue template list instead of blank issue from meta links

* Fix typo in markdown in docs issue template

* Add Jenkins Discourse section in index, revisit index and about pages

* Fix favicon not showing by generating more favicon sizes with icongen
This commit is contained in:
Sig00rd 2021-08-18 17:53:19 +02:00 committed by GitHub
parent 38e46a13dd
commit e88d63fdf7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
21 changed files with 37 additions and 33 deletions

View File

@ -7,7 +7,7 @@ projects: ''
assignees: '' assignees: ''
--- ---
**Relevant links* **Relevant links**
Link(s) to the section(s) of documentation that are outdated or otherwise wrong Link(s) to the section(s) of documentation that are outdated or otherwise wrong
**Description** **Description**

View File

@ -24,20 +24,15 @@ linkTitle = "Jenkins Kubernetes Operator"
{{% /blocks/section %}} {{% /blocks/section %}}
{{% blocks/lead color="primary" %}} {{% blocks/lead color="primary" %}}
Jenkins operator is a Kubernetes native operator which fully manages Jenkins on Kubernetes.<br /> It was built with immutability and declarative configuration as code in mind.<br /> Jenkins Operator is a Kubernetes native operator which fully manages Jenkins on Kubernetes.<br /> It was built with immutability and declarative configuration as code in mind.<br />
{{% /blocks/lead %}} {{% /blocks/lead %}}
{{< blocks/section color="dark" >}} {{< blocks/section color="dark" >}}
{{% blocks/feature icon="fa-hdd" title="Volumes handling" %}}
AWS EBS volume attach/detach issue when using PVC
{{% /blocks/feature %}}
{{% blocks/feature icon="fas fa-cogs" title="Better configuration as code" %}} {{% blocks/feature icon="fas fa-cogs" title="Better configuration as code" %}}
Use groovy scripts or JCasC to configure your Jenkins instance Use groovy scripts or JCasC to configure your Jenkins instance
{{% /blocks/feature %}} {{% /blocks/feature %}}
{{% blocks/feature icon="fas fa-shield-alt" title="Security and hardening out of the box" %}} {{% blocks/feature icon="fas fa-shield-alt" title="Security and hardening out of the box" %}}
Enable CSRF, disable usage stats, enable master access control and more by default Enable CSRF, disable usage stats, enable master access control and more by default
{{% /blocks/feature %}} {{% /blocks/feature %}}
@ -50,10 +45,6 @@ Less chance to lose data
Improve user experience by informing what has been done Improve user experience by informing what has been done
{{% /blocks/feature %}} {{% /blocks/feature %}}
{{% blocks/feature icon="fas fa-file-archive" title="Backup and restore for jobs history" %}}
Prevent loss of job history
{{% /blocks/feature %}}
{{< /blocks/section >}} {{< /blocks/section >}}
@ -69,14 +60,19 @@ We do a Pull Request contributions workflow on **GitHub**. New users are always
Learning the usage of Jenkins Operator will make your life easier. After that, you can easily contribute to the project. Learning the usage of Jenkins Operator will make your life easier. After that, you can easily contribute to the project.
{{% /blocks/feature %}} {{% /blocks/feature %}}
{{% blocks/feature icon="fab fa-slack" title="Join #jenkins-operator on Slack!" %}} {{% blocks/feature icon="fab fa-jenkins" title="Jenkins Community Discourse" %}}
Ask questions, receive help and talk with other users about operator on dedicated Slack channel. Ask questions, discuss best practices and talk to other users about Jenkins Operator on a dedicated Discourse category.
<a href="https://community.jenkins.io/c/contributing/jenkins-operator/20">Visit Discourse</a>
{{% /blocks/feature %}}
{{% blocks/feature icon="fab fa-slack" title="Join #jenkins-operator on Slack!" %}}
Chat with other users about Jenkins Operator on dedicated Slack channel.
<a href="https://forms.gle/X3X8qA1XMirdBuEH7">Invite form</a> <a href="https://forms.gle/X3X8qA1XMirdBuEH7">Invite form</a>
<a href="https://virtuslab-oss.slack.com">Go to Slack</a> <a href="https://virtuslab-oss.slack.com">Go to Slack</a>
{{% /blocks/feature %}} {{% /blocks/feature %}}
{{< /blocks/section >}} {{< /blocks/section >}}

View File

@ -21,20 +21,18 @@ Jenkins Operator is a Kubernetes native operator which fully manages Jenkins on
<img src="/kubernetes-operator/img/logo.svg" style="height: 75%; margin-left: -75%; margin-top: 50%;" alt="Logo"/> <img src="/kubernetes-operator/img/logo.svg" style="height: 75%; margin-left: -75%; margin-top: 50%;" alt="Logo"/>
</div> </div>
<div class="col-md-4 col-lg-8 order-xs-2 order-sm-2 order-md-2"> <div class="col-md-4 col-lg-8 order-xs-2 order-sm-2 order-md-2">
<h1>The main reason why we decided to write the <b>jenkins-operator</b> is the fact that we faced a lot of problems with standard Jenkins deployment. We want to make Jenkins more robust, suitable for dynamic and multi-tenant environments.</h1> <h1>The main reason why we decided to develop the <b>Jenkins Operator</b> is the fact that we faced a lot of problems with standard Jenkins deployment. We want to make Jenkins more robust, suitable for dynamic and multi-tenant environments.</h1>
<p class="lead mt-2"> <p class="lead mt-2">
<br /> <br />
Some of the problems we want to solve: Some of the problems we want to solve:
<ul> <ul>
<li>Volumes handling (AWS EBS volume attach/detach issue when using PVC)</li>
<li>Installing plugins with incompatible versions or security vulnerabilities</li> <li>Installing plugins with incompatible versions or security vulnerabilities</li>
<li>Better configuration as code</li> <li>Better configuration as code</li>
<li>Lack of end to end tests</li> <li>Lack of end to end tests</li>
<li>Handle graceful shutdown properly</li> <li>Handling graceful shutdown properly</li>
<li>Security and hardening out of the box</li> <li>Security and hardening out of the box</li>
<li>Orphaned jobs with no jnlp connection</li> <li>Orphaned jobs with no jnlp connection</li>
<li>Make errors more visible for end users</li> <li>Making errors more visible for end users</li>
<li>Backup and restore for jobs history</li>
</ul> </ul>
</p> </p>

View File

@ -4,11 +4,11 @@ linkTitle: "Latest (v0.6.x)"
weight: 10 weight: 10
date: 2021-01-18 date: 2021-01-18
description: > description: >
How to work with jenkins-operator to be released version How to work with the latest, currently supported Jenkins Operator version.
--- ---
{{% pageinfo %}} {{% pageinfo %}}
This document describes a getting started guide for **Jenkins Operator** currently in preview version and an additional configuration. This document describes a getting started guide for **Jenkins Operator** `v0.6.x` and also additional configuration.
{{% /pageinfo %}} {{% /pageinfo %}}
## First Steps ## First Steps

View File

@ -4,11 +4,11 @@ linkTitle: "v0.1.x"
weight: 10 weight: 10
date: 2019-08-05 date: 2019-08-05
description: > description: >
How to work with an older version of jenkins-operator. We recommend migration to a newer version. How to work with Jenkins Operator 0.1.x version. We recommend migrating to a newer version.
--- ---
{{% pageinfo %}} {{% pageinfo %}}
This document describes a getting started guide for **Jenkins Operator** `v0.1.x` and an additional configuration. This document describes a getting started guide for **Jenkins Operator** `v0.1.x` and also additional configuration.
{{% /pageinfo %}} {{% /pageinfo %}}
## First Steps ## First Steps

View File

@ -4,11 +4,11 @@ linkTitle: "v0.2.x"
weight: 10 weight: 10
date: 2019-08-05 date: 2019-08-05
description: > description: >
How to work with an older version of jenkins-operator. We recommend migration to a newer version. How to work with Jenkins Operator 0.2.x version. We recommend migrating to a newer version.
--- ---
{{% pageinfo %}} {{% pageinfo %}}
This document describes a getting started guide for **Jenkins Operator** `v0.2.x` and an additional configuration. This document describes a getting started guide for **Jenkins Operator** `v0.2.x` and also additional configuration.
{{% /pageinfo %}} {{% /pageinfo %}}
## First Steps ## First Steps

View File

@ -4,11 +4,11 @@ linkTitle: "v0.3.x"
weight: 10 weight: 10
date: 2019-12-20 date: 2019-12-20
description: > description: >
How to work with an older version of jenkins-operator. We recommend migration to a newer version. How to work with Jenkins Operator 0.3.x version. We recommend migrating to a newer version.
--- ---
{{% pageinfo %}} {{% pageinfo %}}
This document describes a getting started guide for **Jenkins Operator** `v0.3.x` and an additional configuration. This document describes a getting started guide for **Jenkins Operator** `v0.3.x` and also additional configuration.
{{% /pageinfo %}} {{% /pageinfo %}}
## First Steps ## First Steps

View File

@ -4,11 +4,11 @@ linkTitle: "v0.4.x"
weight: 10 weight: 10
date: 2020-04-13 date: 2020-04-13
description: > description: >
How to work with jenkins-operator latest version How to work with Jenkins Operator 0.4.x version. We recommend migrating to a newer version.
--- ---
{{% pageinfo %}} {{% pageinfo %}}
This document describes a getting started guide for **Jenkins Operator** `v0.4.x` and an additional configuration. This document describes a getting started guide for **Jenkins Operator** `v0.4.x` and also additional configuration.
{{% /pageinfo %}} {{% /pageinfo %}}
## First Steps ## First Steps

View File

@ -4,11 +4,11 @@ linkTitle: "v0.5.x"
weight: 10 weight: 10
date: 2021-01-18 date: 2021-01-18
description: > description: >
How to work with jenkins-operator latest version How to work with Jenkins Operator 0.5.x version. We recommend migrating to a newer version.
--- ---
{{% pageinfo %}} {{% pageinfo %}}
This document describes a getting started guide for **Jenkins Operator** `v0.5.x` and an additional configuration. This document describes a getting started guide for **Jenkins Operator** `v0.5.x` and also additional configuration.
{{% /pageinfo %}} {{% /pageinfo %}}
## First Steps ## First Steps

View File

@ -7,11 +7,11 @@
{{ if .Site.IsMultiLingual }} {{ if .Site.IsMultiLingual }}
{{ $editURL = printf "%s/edit/master/website/content/%s/%s" $gh_repo ($.Site.Language.Lang) .Path }} {{ $editURL = printf "%s/edit/master/website/content/%s/%s" $gh_repo ($.Site.Language.Lang) .Path }}
{{ end }} {{ end }}
{{ $issuesURL := printf "%s/issues/new?title=%s" $gh_repo (htmlEscape $.Title )}} {{ $issuesURL := printf "%s/issues/new?labels=documentation&template=documentation.md&title=%s" $gh_repo (htmlEscape $.Title )}}
<a href="{{ $editURL }}" target="_blank"><i class="fa fa-edit fa-fw"></i> {{ T "post_edit_this" }}</a> <a href="{{ $editURL }}" target="_blank"><i class="fa fa-edit fa-fw"></i> {{ T "post_edit_this" }}</a>
<a href="{{ $issuesURL }}" target="_blank"><i class="fab fa-github fa-fw"></i> {{ T "post_create_issue" }}</a> <a href="{{ $issuesURL }}" target="_blank"><i class="fab fa-github fa-fw"></i> {{ T "post_create_issue" }}</a>
{{ if $gh_project_repo }} {{ if $gh_project_repo }}
{{ $project_issueURL := printf "%s/issues/new" $gh_project_repo }} {{ $project_issueURL := printf "%s/issues/new/choose" $gh_project_repo }}
<a href="{{ $project_issueURL }}" target="_blank"><i class="fas fa-tasks fa-fw"></i> {{ T "post_create_project_issue" }}</a> <a href="{{ $project_issueURL }}" target="_blank"><i class="fas fa-tasks fa-fw"></i> {{ T "post_create_project_issue" }}</a>
{{ end }} {{ end }}
</div> </div>

View File

@ -0,0 +1,10 @@
{{ $icon := .Get "icon" | default "fa-lightbulb" }}
{{ $url_text := .Get "url_text" }}
<div class="col-lg-3 mb-5 mb-lg-3 text-center ">
<div class="mb-4 h1">
<i class="{{ if not (or (hasPrefix $icon "fas ") (hasPrefix $icon "fab ")) }}fas {{ end }}{{ $icon }}"></i>
</div>
<h4 class="h3">{{ .Get "title" | markdownify }}</h4>
<p class="mb-0">{{ .Inner }}</p>
{{ with .Get "url" }}<p><a href="{{ . }}">{{ with $url_text }}{{ $url_text }}{{ else }}{{ T "ui_read_more" }}{{ end }} …</a></p>{{ end }}
</div>

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 698 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.7 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 15 KiB

After

Width:  |  Height:  |  Size: 1.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 25 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.0 KiB