Update project and repo documents (#621)
* Removed Contributor Covenant version from Code of Conduct doc * Added a note on PRs with changes to Helm Chart to CONTRIBUTING doc * Mentioned Discourse as current main channel of communication in README * Updated ROADMAP
This commit is contained in:
Sig00rd
GitHub
parent
851fb0d3e9
commit
058ea61d70
|
|
@ -3,4 +3,3 @@
|
|||
You can find the Jenkins Code of Conduct [on jenkins.io](https://jenkins.io/project/conduct/).
|
||||
|
||||
It applies to the entire `jenkinsci` GitHub organization, among other community spaces.
|
||||
[version]: http://contributor-covenant.org/version/1/4/
|
||||
|
|
@ -4,7 +4,7 @@ Thanks for taking the time to contribute!
|
|||
|
||||
## Code of Conduct
|
||||
|
||||
This project and everyone participating in it is governed by the [Atom Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
|
||||
This project and everyone participating in it is governed by the [Jenkins Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
|
||||
|
||||
## We Develop with GitHub
|
||||
We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.
|
||||
|
|
@ -41,3 +41,10 @@ Design proposal is simply a document that states what you propose to do includin
|
|||
- Breaking changes
|
||||
|
||||
Keep in mind that a proposal is not a pitch, it needs to be technical.
|
||||
|
||||
### Proposing changes to Helm Chart
|
||||
When issuing a PR that modifies the project's Helm Chart, please do not include in your PR changes that would release a new package version when merged.
|
||||
|
||||
Specifically, please do not update `chart/index.yaml` and `chart/jenkins-operator/Chart.yaml` files and do not build chart archive package.
|
||||
|
||||
For the sake of PR's brevity and security, Project's maintainers will issue a separate PR that releases new version of the Chart after your PR has been merged.
|
||||
|
|
@ -62,8 +62,11 @@ Selected content:
|
|||
- Multibranch Pipelines and Backup Issues: https://github.com/jenkinsci/kubernetes-operator/issues/104#issuecomment-554289768
|
||||
|
||||
## Community
|
||||
Main channel of communication on topics related to Jenkins Operator is [Jenkins Operator Category](https://community.jenkins.io/c/contributing/jenkins-operator/20) on [Jenkins Community Discourse](https://community.jenkins.io/).
|
||||
|
||||
We have a dedicated channel called `#jenkins-operator` on [virtuslab-oss.slack.com](https://virtuslab-oss.slack.com)
|
||||
Here you can ask questions about the project, discuss best practices on using it, and talk to other users of the Operator, contributors and project's maintainers.
|
||||
|
||||
We also have a dedicated channel called `#jenkins-operator` on [virtuslab-oss.slack.com](https://virtuslab-oss.slack.com).
|
||||
Fill out ([Invite form](https://forms.gle/X3X8qA1XMirdBuEH7)) and come say hi!
|
||||
|
||||
## Snapshots between releases
|
||||
|
|
@ -77,7 +80,8 @@ Look for the images with tag "{git-hash}", where {git-hash} is the hash of the m
|
|||
|
||||
## Contribution
|
||||
|
||||
Feel free to file [issues](https://github.com/jenkinsci/kubernetes-operator/issues) or [pull requests](https://github.com/jenkinsci/kubernetes-operator/pulls).
|
||||
Feel free to file [issues](https://github.com/jenkinsci/kubernetes-operator/issues) or [pull requests](https://github.com/jenkinsci/kubernetes-operator/pulls),
|
||||
but please consult [CONTRIBUTING](https://github.com/jenkinsci/kubernetes-operator/CONTRIBUTING.md) document beforehand.
|
||||
|
||||
Before any big pull request please consult the maintainers to ensure a common direction.
|
||||
|
||||
|
|
@ -85,6 +89,7 @@ Before any big pull request please consult the maintainers to ensure a common di
|
|||
|
||||
- [Jenkins World 2019 Lisbon](assets/Jenkins_World_Lisbon_2019%20-Jenkins_Kubernetes_Operator.pdf)
|
||||
- [Jenkins Online Meetup 2020](assets/Jenkins_Online_Meetup-Jenkins_Kubernetes_Operator.pdf)
|
||||
- [Jenkins Online Meetup 2021](https://www.youtube.com/watch?v=BsYYVkophsk)
|
||||
|
||||
## About the authors
|
||||
|
||||
|
|
|
|||
25
ROADMAP.md
25
ROADMAP.md
|
|
@ -4,37 +4,28 @@ This document outlines the vision and technical roadmap for [jenkinsci/kubernete
|
|||
|
||||
## Project Vision
|
||||
|
||||
With Jenkins Operator project we want to enable our community to run Jenkins in cloud-native environments like Kubernetes, OpenShift and others. Also, support most of the public cloud providers (AWS, Azure, GCP) in terms of additional capabilities like backups, observability and cloud security.
|
||||
|
||||
With Jenkins Operator project we want to enable our community to run Jenkins in cloud-native environments. Also, support most of the public cloud providers (AWS, Azure, GCP) in terms of additional capabilities like backups, observability and cloud security.
|
||||
|
||||
With declarative configuration and full lifecycle management based on [Operator Framework](https://operatorframework.io/) this can become the de facto standard for running Jenkins on top of Kubernetes.
|
||||
|
||||
|
||||
Now, we have a dedicated team which can bring more engineering effort to the project.
|
||||
|
||||
## Technical Roadmap
|
||||
|
||||
- Upgrade Operator SDK [#494](https://github.com/jenkinsci/kubernetes-operator/issues/494)
|
||||
- https://github.com/operator-framework/operator-sdk/releases/tag/v1.3.0
|
||||
- Modularise codebase and define areas of responsibility (AWS, Azure, OpenShift)
|
||||
- Break down Jenkins Custom Resource into smaller parts, support multiple Custom Resource Definitions [#495](https://github.com/jenkinsci/kubernetes-operator/issues/495)
|
||||
- Introduce more granular schema for configuring Jenkins
|
||||
- Introduce independent reconciliation controllers
|
||||
- Refactor e2e tests to support testing individual reconciliation controller
|
||||
- Refactor e2e tests to support testing individual reconciliation controllers
|
||||
- Migrate Jenkins instance from Pod to Deployment [#497](https://github.com/jenkinsci/kubernetes-operator/issues/497)
|
||||
- Unblock easier integration with 3rd party systems e.g. sidecars injection
|
||||
- Improve contribution process and establish governance model [#496](https://github.com/jenkinsci/kubernetes-operator/issues/496)
|
||||
- Improve CONTRIBUTING.md
|
||||
- Introduce architecture decision proposals process
|
||||
- Introduce governance model
|
||||
- Migrate Jenkins instance from Pod to Deployment [#497](https://github.com/jenkinsci/kubernetes-operator/issues/497)
|
||||
- Unblock easier integration with 3rd party systems e.g. sidecars injection
|
||||
- Engage with community more
|
||||
- After releasing Operator version with new API, gather feedback from users on where the Operator should go next
|
||||
- Reference Architecture - Jenkins on Kubernetes
|
||||
- Bridge the gap between Jenkins and Kubernetes
|
||||
- https://www.jenkins.io/blog/2020/12/04/gsod-project-report/
|
||||
- Pay technical debt
|
||||
- Review existing issues on GitHub and prioritise them
|
||||
- Introduce project board to track milestones
|
||||
- Fix existing bugs
|
||||
|
||||
|
||||
## Have a Question?
|
||||
|
||||
In case of further question feel free to create an issue or contact us directly.
|
||||
In case of questions, feel free to create a thread on [Jenkins Operator Category](https://community.jenkins.io/c/contributing/jenkins-operator/20) of Jenkins Community Discourse or contact us directly.
|
||||
|
|
|
|||
Loading…
Reference in New Issue