This is an automated email from the ASF dual-hosted git repository.
klesh 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 e34204921f docs: add discoverability for Swagger doc (#488)
e34204921f is described below
commit e34204921facc55c6062d9c41a5a08307c188030
Author: Louis.z <[email protected]>
AuthorDate: Wed Apr 19 14:43:30 2023 +0800
docs: add discoverability for Swagger doc (#488)
Co-authored-by: Startrekzky <[email protected]>
---
docs/DeveloperManuals/SourceCodeReference.md | 12 ++++++++++++
docs/Overview/References.md | 13 ++-----------
.../version-v0.16/DeveloperManuals/SourceCodeReference.md | 12 ++++++++++++
versioned_docs/version-v0.16/Overview/References.md | 13 ++-----------
4 files changed, 28 insertions(+), 22 deletions(-)
diff --git a/docs/DeveloperManuals/SourceCodeReference.md
b/docs/DeveloperManuals/SourceCodeReference.md
new file mode 100644
index 0000000000..de4002c805
--- /dev/null
+++ b/docs/DeveloperManuals/SourceCodeReference.md
@@ -0,0 +1,12 @@
+---
+title: "Source Code References"
+description: >
+ Source Code References
+sidebar_position: 1
+---
+
+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.
+
diff --git a/docs/Overview/References.md b/docs/Overview/References.md
index 32515fb811..eb2ed0dbfd 100644
--- a/docs/Overview/References.md
+++ b/docs/Overview/References.md
@@ -1,13 +1,10 @@
---
-title: "References"
+title: "API References"
description: >
- References
+ API 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`:
@@ -19,10 +16,4 @@ 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.
diff --git
a/versioned_docs/version-v0.16/DeveloperManuals/SourceCodeReference.md
b/versioned_docs/version-v0.16/DeveloperManuals/SourceCodeReference.md
new file mode 100644
index 0000000000..de4002c805
--- /dev/null
+++ b/versioned_docs/version-v0.16/DeveloperManuals/SourceCodeReference.md
@@ -0,0 +1,12 @@
+---
+title: "Source Code References"
+description: >
+ Source Code References
+sidebar_position: 1
+---
+
+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.
+
diff --git a/versioned_docs/version-v0.16/Overview/References.md
b/versioned_docs/version-v0.16/Overview/References.md
index 32515fb811..eb2ed0dbfd 100644
--- a/versioned_docs/version-v0.16/Overview/References.md
+++ b/versioned_docs/version-v0.16/Overview/References.md
@@ -1,13 +1,10 @@
---
-title: "References"
+title: "API References"
description: >
- References
+ API 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`:
@@ -19,10 +16,4 @@ 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.
