You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Contributions are required to follow these style guides:
45
52
46
53
-[Error Message Style Guide]
47
54
-[Documentation Style Guide]
48
55
49
-
## Building the Source
56
+
## Contributing to `kpt`
57
+
58
+
The kpt toolchain has several components such as `kpt CLI`, `package orchestrator`,
59
+
`function catalog`, `function SDKs`, `Backstage UI plugin` and `config sync`. Each
60
+
component has their own development process.
61
+
Refer to the pointers below to learn more:
62
+
63
+
### kpt CLI
64
+
65
+
#### Building the Source
50
66
51
67
1. Clone the project
52
68
@@ -67,18 +83,28 @@ Contributions are required to follow these style guides:
67
83
make all
68
84
```
69
85
70
-
## Contribution to the Functions Catalog
86
+
### Package Orchestrator
87
+
88
+
Package orchestrator code live under `porch` directory in this repo. Please see the
89
+
[developer docs for porch](porch/docs/development.md) to learn more.
90
+
91
+
### Function Catalog
71
92
72
-
Refer to the
93
+
Function catalog has its own repository. Refer to the
73
94
[documentation in the kpt-functions-catalog](https://github.com/GoogleContainerTools/kpt-functions-catalog/blob/master/CONTRIBUTING.md)
74
95
repo.
75
96
76
-
## Contributing to Documentation
97
+
### Config Sync
98
+
99
+
Config Sync has its own [repository](https://github.com/GoogleContainerTools/kpt-config-sync).
100
+
Refer to the [documentation in the config-sync repo](https://github.com/GoogleContainerTools/kpt-config-sync/blob/main/docs/contributing.md).
101
+
102
+
### Documentation
77
103
78
104
If you are updating the documentation, please do it in separate PRs from code
79
105
changes and PR description should start with `Docs:`.
80
106
81
-
### Run the docs locally
107
+
####Run the docs locally
82
108
83
109
Make docs changes and test them by running the site in a docker container with
84
110
`make site-run-server`.
@@ -88,12 +114,12 @@ It's usually a good idea to test locally for the following:
88
114
- Broken links
89
115
- Rendering static content
90
116
91
-
### Update docs
117
+
####Update docs
92
118
93
119
Docs are under [site/] and use [docsify] to present the source markdown files.
94
120
The sidebar is automatically updated for the site at deployment time.
95
121
96
-
### Docs Hygiene
122
+
####Docs Hygiene
97
123
98
124
The kpt website uses markdownlint to lint docs for formatting and style. Use
99
125
prettier with the `"prettier.proseWrap": "always"` setting to auto-format docs
0 commit comments