Skip to content

Commit 083b05a

Browse files
Add documentation section to README (#368)
1 parent e0d2933 commit 083b05a

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,23 @@ $ ./_build/kvctl migrate slot 123 --target 1 -n test-ns -c test-cluster
118118

119119
For the HTTP API, you can find the [HTTP API(work in progress)](docs/API.md) for more details.
120120

121+
## Documentation
122+
123+
At the moment, there is no dedicated documentation page specifically for the Kvrocks Controller.
124+
Most information is currently available in the source code and in the main Kvrocks documentation.
125+
126+
To help new contributors and users, here are the useful resources:
127+
128+
- Official Kvrocks Documentation:
129+
https://kvrocks.apache.org/
130+
131+
- Configuration examples for the controller can be found inside the `config/` directory.
132+
133+
- API usage examples are provided in this README and in the source files under the `controller/` directory.
134+
135+
More structured and detailed documentation for the Kvrocks Controller will be added in the future.
136+
Contributions to improve the documentation are always welcome.
137+
121138
## License
122139

123140
Licensed under the [Apache License, Version 2.0](LICENSE)

0 commit comments

Comments
 (0)