Update README.md #204
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,5 +1,10 @@ | ||||||
| # jenkins-k8s-operator | ||||||
|
|
||||||
| [](https://charmhub.io/jenkins-k8s) | ||||||
| [](https://github.com/canonical/jenkins-k8s-operator/actions/workflows/publish_charm.yaml) | ||||||
| [](https://github.com/canonical/jenkins-k8s-operator/actions/workflows/promote_charm.yaml) | ||||||
| [](https://discourse.charmhub.io) | ||||||
|
|
||||||
| A [Juju](https://juju.is/) [charm](https://juju.is/docs/olm/charmed-operators) | ||||||
| deploying and managing [Jenkins](https://jenkins.io/) on Kubernetes. Jenkins is an open source | ||||||
| automation server, providing plugins to support building, deploying and automating any project. | ||||||
|
|
@@ -15,30 +20,35 @@ For DevOps and SRE teams, this charm will make operating Jenkins simple and stra | |||||
| through Juju's clean interface. Allowing both kubernetes and machine agent relations, it supports | ||||||
| multiple environments for automation. | ||||||
|
|
||||||
| For information about how to deploy, integrate, and manage this charm, see the Official [jenkins-k8s charm Documentation](https://charmhub.io/jenkins-k8s/docs). | ||||||
|
|
||||||
| ## Get started | ||||||
|
|
||||||
| To begin, refer to the [Getting Started](https://charmhub.io/jenkins-k8s/docs/tutorial-getting-started) tutorial for step-by-step instructions. | ||||||
|
|
||||||
| ### Basic operations | ||||||
|
|
||||||
| #### Expose jenkins-k8s through ingress | ||||||
|
|
||||||
| See the [Expose jenkins-k8s through ingress](https://charmhub.io/jenkins-k8s/docs/tutorial-getting-started#expose-jenkins-k8s-through-ingress) section in the jenkins-k8s-operator documentation. | ||||||
|
|
||||||
| #### Integrate with the jenkins-agent and the jenkins-agent-k8s charm | ||||||
|
|
||||||
| See the [deploy and integrate k8s agents](https://charmhub.io/jenkins-k8s/docs/tutorial-getting-started#deploy-and-integrate-k8s-agents) section and the [deploy and integrate machine agents](https://charmhub.io/jenkins-k8s/docs/tutorial-getting-started#deploy-and-integrate-machine-agents-optional) section in the jenkins-k8s-operator documentation. | ||||||
|
|
||||||
| #### Use agent-discovery-ingress integration to integrate with "external" agents | ||||||
|
|
||||||
| See the [how-to-integrate-with-external-agents](https://charmhub.io/jenkins-k8s/docs/how-to-integrate-with-external-agents) section in the jenkins-k8s-operator documentation. | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| ## Learn more | ||||||
|
|
||||||
| - [Read more](https://charmhub.io/jenkins-k8s/docs) | ||||||
|
|
||||||
|
There was a problem hiding this comment.
|
||||||
| ## Project and community | ||||||
|
|
||||||
| The Jenkins-agent-k8s Operator is a member of the Ubuntu family. It's an open source project that warmly welcomes community projects, contributions, suggestions, fixes and constructive feedback. | ||||||
|
|
||||||
| * [Issues](https://github.com/canonical/jenkins-k8s-operator/issues) <!--Link to GitHub issues (if applicable)--> | ||||||
| * [Contributing](https://charmhub.io/jenkins-k8s#contributing-to-this-documentation) <!--Link to any contribution guides--> | ||||||
|
There was a problem hiding this comment. Could you link https://github.com/canonical/jenkins-k8s-operator/blob/main/CONTRIBUTING.md instead? |
||||||
| - [Matrix](https://matrix.to/#/#charmhub-charmdev:ubuntu.com) | ||||||
|
|
||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.