This is an automated email from the ASF dual-hosted git repository.
yumeng pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-devlake-website.git
The following commit(s) were added to refs/heads/main by this push:
new a9ad8d461 docs: add References page (#344)
a9ad8d461 is described below
commit a9ad8d46112ee273003725d7e838f851f9e5b32a
Author: Klesh Wong <[email protected]>
AuthorDate: Mon Dec 12 10:18:24 2022 +0800
docs: add References page (#344)
---
docs/Overview/References.md | 28 ++++++++++++++++++++++++++++
1 file changed, 28 insertions(+)
diff --git a/docs/Overview/References.md b/docs/Overview/References.md
new file mode 100644
index 000000000..32515fb81
--- /dev/null
+++ b/docs/Overview/References.md
@@ -0,0 +1,28 @@
+---
+title: "References"
+description: >
+ References
+sidebar_position: 6
+---
+
+
+## RESTful API Reference
+
+For users/developers who wish to interact with the Apache DevLake by using the
RESTful APIs,
+the Swagger Document would very useful for you. The `devlake` docker image has
it packaged, you may access it from:
+If you are using the `devlake` container alone without `config-ui`:
+```
+http://<DEVLAKE_CONTIANER_HOST>:<PORT>/swagger/index.html
+```
+or
+```
+http://<CONFIG_UI_CONTIANER_HOST>:<PORT>/api/swagger/index.html
+```
+
+## Source Code Reference
+
+For developers who wish to contribute to or develop based on the Apache
DevLake, the
+[pkg.go.dev](https://pkg.go.dev/github.com/apache/incubator-devlake#section-documentation)
+is a good resource for reference, you can learn the overall structure of the
code base or
+the definition of a specific function.
+
