15308555518/ website
1
0
Fork 0
mirror of https://github.com/kubesphere/website.git synced 2025-12-26 00:12:48 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
website/developer-guide/development
History
FeynmanZhou d7a3bee059 init contribution and developer guides 
Signed-off-by: FeynmanZhou <pengfeizhou@yunify.com>
 		2020-03-16 14:39:10 +08:00
..
sig-observability init contribution and developer guides 2020-03-16 14:39:10 +08:00
README.md init contribution and developer guides 2020-03-16 14:39:10 +08:00
development-workflow.md init contribution and developer guides 2020-03-16 14:39:10 +08:00
how-to-build.md init contribution and developer guides 2020-03-16 14:39:10 +08:00
how-to-connect-remote-service.md init contribution and developer guides 2020-03-16 14:39:10 +08:00
how-to-run-kubesphere-core.md init contribution and developer guides 2020-03-16 14:39:10 +08:00
kubesphere-code-layout.md init contribution and developer guides 2020-03-16 14:39:10 +08:00
pull-requests.md init contribution and developer guides 2020-03-16 14:39:10 +08:00

README.md

Guides

There are many ways that you can help the KubeSphere community.

  • Go through our documents, point out or fix unclear things. Translate the documents to other languages.
  • Install our releases, try to manage your kubernetes cluster with kubesphere, and feedback to us about what you think.
  • Read our source codes, Ask questions for details.
  • Find kubesphere bugs, submit issue, and try to fix it.
  • Find kubesphere installer bugs, submit issue, and try to fix it.
  • Find help wanted issues, which are good for you to start.
  • Submit issue or start discussion through GitHub issue.
  • See all forum discussion through website.

Contact Us

All the following channels are open to the community, you could choose the way you like.

For code developer

  1. Learn about kubesphere's Concepts And Designs and how to build kubesphere locally
    For developers, first step, read Concepts And Designs and Compiling Guide. Concepts And Designs describes the role of each component in kubesphere and the relationship between them. Compiling Guide teaches developer how to build the project in local and set up the environment.

  2. Understand the workflow of kubesphere development.
    Read Development Workflow.

  3. Learn KubeSphere code layout

Read KubeSphere Code Layout.

  1. Understand the best practices for submitting PR and our code of conduct
    Read best practices for submitting PR.
    Read code of conduct.

KubeSphere Installer developer

UI developer

TODO: UI opensource is on the way

KubeSphere Application Management developer

TODO(@pengcong)

KubeSphere Service Mesh developer

TODO(@zryfish)

Porter developer

TODO(@magicsong)

KubeSphere Networking developer

KubeSphere DevOps developer

Users who are interested in DevOps Pipeline, you can read the documentation according to the guidelines above.

The function of KubeSphere DevOps is mainly provided by KubeSphere apiserver.

KubeSphere S2I/B2I developer

  1. If users who are interested in S2I/B2I, please read S2I/B2I to get start it.

  2. For developers who want to contribute, see Development Guide for S2I/B2I

KubeSphere Monitoring developer

  1. Read kubesphere's Concepts And Designs for Monitoring. Understand KubeSphere's monitoring stack.
  2. For Prometheus and its wider eco-system setup, go to kube-prometheus.
  3. For KubeSphere builtin metric rules, see metrics_rules.go and kubernetes-mixin.
  4. For developers who are interested in KubeSphere monitoring backend, read Development Guide for Monitoring and API doc.

KubeSphere Logging developer

  1. Read kubesphere's Concepts And Designs for Logging. Understand KubeSphere's logging stack.
  2. Find the component you are interested in and start from its own repo: Fluent Bit, Fluent-bit Operator and Logsidecar Injector.
  3. For developers who are interested in KubeSphere logging backend, read Development Guide for Logging and API doc.

KubeSphere Altering developer

TODO

KubeSphere Notification developer

TODO