Skip to content

Commit

Permalink
Refactoring documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@zeroc0d3
zeroc0d3 committed May 9, 2023
1 parent 614ed96 commit cf8700d
Show file tree
Hide file tree
Showing 17 changed files with 141 additions and 79 deletions.
25 changes: 14 additions & 11 deletions docs/RESTful API - Golang Bookstore - v2.0.postman_collection.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@
}
}
],
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"method": "GET",
"header": [
Expand Down Expand Up @@ -68,7 +71,7 @@
"mode": "raw",
"raw": ""
},
"url": "{{api_url}}:8080",
"url": "{{api_url_elb}}:8080",
"description": "localhost:8080/books"
},
"response": []
Expand Down Expand Up @@ -105,7 +108,7 @@
"mode": "raw",
"raw": ""
},
"url": "{{api_url}}:8080/health",
"url": "{{api_url_elb}}:8080/health",
"description": "localhost:8080/books"
},
"response": []
Expand Down Expand Up @@ -142,7 +145,7 @@
"mode": "raw",
"raw": ""
},
"url": "{{api_url}}:8080/metrics",
"url": "{{api_url_elb}}:8080/metrics",
"description": "localhost:8080/books"
},
"response": []
Expand Down Expand Up @@ -234,7 +237,7 @@
"mode": "raw",
"raw": "{\n \"username\": \"devopscorner\",\n \"password\": \"DevOpsCorner2023\"\n}"
},
"url": "{{api_url}}:8080/v1/login",
"url": "{{api_url_elb}}:8080/v1/login",
"description": "localhost:8080/books"
},
"response": []
Expand All @@ -255,7 +258,7 @@
"type": "text"
}
],
"url": "{{api_url}}:8080/v1/books",
"url": "{{api_url_elb}}:8080/v1/books",
"description": "localhost:8080/books"
},
"response": []
Expand All @@ -276,7 +279,7 @@
"type": "text"
}
],
"url": "{{api_url}}:8080/v1/books/1681899565360226000",
"url": "{{api_url_elb}}:8080/v1/books/1682647627893145000",
"description": "localhost:8080/books"
},
"response": []
Expand All @@ -301,7 +304,7 @@
"mode": "raw",
"raw": "{\n \"title\": \"Mastering Go: Create Golang production applications using network libraries, concurrency, and advanced Go data structures\",\n \"author\": \"Mihalis Tsoukalos\",\n \"year\": \"2023\"\n}"
},
"url": "{{api_url}}:8080/v1/books",
"url": "{{api_url_elb}}:8080/v1/books",
"description": "localhost:8080/books"
},
"response": []
Expand All @@ -326,7 +329,7 @@
"mode": "raw",
"raw": "{\n \"title\": \"Introducing Go: Build Reliable, Scalable Programs\",\n \"author\": \"Caleb Doxsey\",\n \"year\": \"2023\"\n}\n"
},
"url": "{{api_url}}:8080/v1/books",
"url": "{{api_url_elb}}:8080/v1/books",
"description": "localhost:8080/books"
},
"response": []
Expand All @@ -351,7 +354,7 @@
"mode": "raw",
"raw": "{\n \"title\": \"Learning Functional Programming in Go: Change the way you approach your applications using functional programming in Go\",\n \"author\": \"Lex Sheehan\",\n \"year\": \"2023\"\n}"
},
"url": "{{api_url}}:8080/v1/books",
"url": "{{api_url_elb}}:8080/v1/books",
"description": "localhost:8080/books"
},
"response": []
Expand All @@ -376,7 +379,7 @@
"mode": "raw",
"raw": "{\n \"title\": \"DevOpsCorner\",\n \"author\": \"DevOpsCorner Indonesia\",\n \"year\": \"2024\"\n}"
},
"url": "{{api_url}}:8080/v1/books/1680783116427044000",
"url": "{{api_url_elb}}:8080/v1/books/1683494642461344000",
"description": "localhost:8080/books/3"
},
"response": []
Expand All @@ -401,7 +404,7 @@
"mode": "raw",
"raw": "{\n \"title\": \"DevOpsCorner\",\n \"author\": \"DevOpsCorner Indonesia\",\n \"year\": \"2024\"\n}"
},
"url": "{{api_url}}:8080/v1/books/10",
"url": "{{api_url_elb}}:8080/v1/books/1683494642461344000",
"description": "localhost:8080/books/3"
},
"response": []
Expand Down
53 changes: 28 additions & 25 deletions docs/RESTful API - Golang Bookstore - v2.1.postman_collection.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@
}
}
],
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"method": "GET",
"header": [
Expand Down Expand Up @@ -81,9 +84,9 @@
"raw": ""
},
"url": {
"raw": "{{api_url}}:8080",
"raw": "{{api_url_elb}}:8080",
"host": [
"{{api_url}}"
"{{api_url_elb}}"
],
"port": "8080"
},
Expand Down Expand Up @@ -124,9 +127,9 @@
"raw": ""
},
"url": {
"raw": "{{api_url}}:8080/health",
"raw": "{{api_url_elb}}:8080/health",
"host": [
"{{api_url}}"
"{{api_url_elb}}"
],
"port": "8080",
"path": [
Expand Down Expand Up @@ -170,9 +173,9 @@
"raw": ""
},
"url": {
"raw": "{{api_url}}:8080/metrics",
"raw": "{{api_url_elb}}:8080/metrics",
"host": [
"{{api_url}}"
"{{api_url_elb}}"
],
"port": "8080",
"path": [
Expand Down Expand Up @@ -271,9 +274,9 @@
"raw": "{\n \"username\": \"devopscorner\",\n \"password\": \"DevOpsCorner2023\"\n}"
},
"url": {
"raw": "{{api_url}}:8080/v1/login",
"raw": "{{api_url_elb}}:8080/v1/login",
"host": [
"{{api_url}}"
"{{api_url_elb}}"
],
"port": "8080",
"path": [
Expand Down Expand Up @@ -302,9 +305,9 @@
}
],
"url": {
"raw": "{{api_url}}:8080/v1/books",
"raw": "{{api_url_elb}}:8080/v1/books",
"host": [
"{{api_url}}"
"{{api_url_elb}}"
],
"port": "8080",
"path": [
Expand Down Expand Up @@ -333,15 +336,15 @@
}
],
"url": {
"raw": "{{api_url}}:8080/v1/books/1681899565360226000",
"raw": "{{api_url_elb}}:8080/v1/books/1682647627893145000",
"host": [
"{{api_url}}"
"{{api_url_elb}}"
],
"port": "8080",
"path": [
"v1",
"books",
"1681899565360226000"
"1682647627893145000"
]
},
"description": "localhost:8080/books"
Expand Down Expand Up @@ -369,9 +372,9 @@
"raw": "{\n \"title\": \"Mastering Go: Create Golang production applications using network libraries, concurrency, and advanced Go data structures\",\n \"author\": \"Mihalis Tsoukalos\",\n \"year\": \"2023\"\n}"
},
"url": {
"raw": "{{api_url}}:8080/v1/books",
"raw": "{{api_url_elb}}:8080/v1/books",
"host": [
"{{api_url}}"
"{{api_url_elb}}"
],
"port": "8080",
"path": [
Expand Down Expand Up @@ -404,9 +407,9 @@
"raw": "{\n \"title\": \"Introducing Go: Build Reliable, Scalable Programs\",\n \"author\": \"Caleb Doxsey\",\n \"year\": \"2023\"\n}\n"
},
"url": {
"raw": "{{api_url}}:8080/v1/books",
"raw": "{{api_url_elb}}:8080/v1/books",
"host": [
"{{api_url}}"
"{{api_url_elb}}"
],
"port": "8080",
"path": [
Expand Down Expand Up @@ -439,9 +442,9 @@
"raw": "{\n \"title\": \"Learning Functional Programming in Go: Change the way you approach your applications using functional programming in Go\",\n \"author\": \"Lex Sheehan\",\n \"year\": \"2023\"\n}"
},
"url": {
"raw": "{{api_url}}:8080/v1/books",
"raw": "{{api_url_elb}}:8080/v1/books",
"host": [
"{{api_url}}"
"{{api_url_elb}}"
],
"port": "8080",
"path": [
Expand Down Expand Up @@ -474,15 +477,15 @@
"raw": "{\n \"title\": \"DevOpsCorner\",\n \"author\": \"DevOpsCorner Indonesia\",\n \"year\": \"2024\"\n}"
},
"url": {
"raw": "{{api_url}}:8080/v1/books/1680783116427044000",
"raw": "{{api_url_elb}}:8080/v1/books/1683494642461344000",
"host": [
"{{api_url}}"
"{{api_url_elb}}"
],
"port": "8080",
"path": [
"v1",
"books",
"1680783116427044000"
"1683494642461344000"
]
},
"description": "localhost:8080/books/3"
Expand Down Expand Up @@ -510,15 +513,15 @@
"raw": "{\n \"title\": \"DevOpsCorner\",\n \"author\": \"DevOpsCorner Indonesia\",\n \"year\": \"2024\"\n}"
},
"url": {
"raw": "{{api_url}}:8080/v1/books/10",
"raw": "{{api_url_elb}}:8080/v1/books/1683494642461344000",
"host": [
"{{api_url}}"
"{{api_url_elb}}"
],
"port": "8080",
"path": [
"v1",
"books",
"10"
"1683494642461344000"
]
},
"description": "localhost:8080/books/3"
Expand Down
Binary file added docs/assets/adot-001.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/adot-002.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/adot-003.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/adot-004.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 1 addition & 2 deletions docs/reproduce-01-teraform-modules.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

ADOT (AWS Distro for OpenTelemetry) Implementation for Simple Golang RESTful API Application (Bookstore)

[goreport](https://goreportcard.com/badge/github.com/devopscorner/golang-adot/src)
[![goreport](https://goreportcard.com/badge/github.com/devopscorner/golang-adot/src)](https://goreportcard.com/badge/github.com/devopscorner/golang-adot/src)
![all contributors](https://img.shields.io/github/contributors/devopscorner/golang-adot)
![tags](https://img.shields.io/github/v/tag/devopscorner/golang-adot?sort=semver)
[![docker pulls](https://img.shields.io/docker/pulls/devopscorner/bookstore-adot.svg)](https://hub.docker.com/r/devopscorner/bookstore-adot/)
Expand Down Expand Up @@ -34,4 +34,3 @@ ADOT (AWS Distro for OpenTelemetry) Implementation for Simple Golang RESTful API
### Check Modules Installed

ls -alR terraform/modules/providers/aws/

2 changes: 1 addition & 1 deletion docs/reproduce-02-helm-template.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

ADOT (AWS Distro for OpenTelemetry) Implementation for Simple Golang RESTful API Application (Bookstore)

[goreport](https://goreportcard.com/badge/github.com/devopscorner/golang-adot/src)
[![goreport](https://goreportcard.com/badge/github.com/devopscorner/golang-adot/src)](https://goreportcard.com/badge/github.com/devopscorner/golang-adot/src)
![all contributors](https://img.shields.io/github/contributors/devopscorner/golang-adot)
![tags](https://img.shields.io/github/v/tag/devopscorner/golang-adot?sort=semver)
[![docker pulls](https://img.shields.io/docker/pulls/devopscorner/bookstore-adot.svg)](https://hub.docker.com/r/devopscorner/bookstore-adot/)
Expand Down
2 changes: 1 addition & 1 deletion docs/reproduce-03-provisioning-tfstate-db-bucket.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

ADOT (AWS Distro for OpenTelemetry) Implementation for Simple Golang RESTful API Application (Bookstore)

[goreport](https://goreportcard.com/badge/github.com/devopscorner/golang-adot/src)
[![goreport](https://goreportcard.com/badge/github.com/devopscorner/golang-adot/src)](https://goreportcard.com/badge/github.com/devopscorner/golang-adot/src)
![all contributors](https://img.shields.io/github/contributors/devopscorner/golang-adot)
![tags](https://img.shields.io/github/v/tag/devopscorner/golang-adot?sort=semver)
[![docker pulls](https://img.shields.io/docker/pulls/devopscorner/bookstore-adot.svg)](https://hub.docker.com/r/devopscorner/bookstore-adot/)
Expand Down
2 changes: 1 addition & 1 deletion docs/reproduce-04-provisioning-infra-core.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

ADOT (AWS Distro for OpenTelemetry) Implementation for Simple Golang RESTful API Application (Bookstore)

[goreport](https://goreportcard.com/badge/github.com/devopscorner/golang-adot/src)
[![goreport](https://goreportcard.com/badge/github.com/devopscorner/golang-adot/src)](https://goreportcard.com/badge/github.com/devopscorner/golang-adot/src)
![all contributors](https://img.shields.io/github/contributors/devopscorner/golang-adot)
![tags](https://img.shields.io/github/v/tag/devopscorner/golang-adot?sort=semver)
[![docker pulls](https://img.shields.io/docker/pulls/devopscorner/bookstore-adot.svg)](https://hub.docker.com/r/devopscorner/bookstore-adot/)
Expand Down
2 changes: 1 addition & 1 deletion docs/reproduce-05-provisioning-infra-cicd.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

ADOT (AWS Distro for OpenTelemetry) Implementation for Simple Golang RESTful API Application (Bookstore)

[goreport](https://goreportcard.com/badge/github.com/devopscorner/golang-adot/src)
[![goreport](https://goreportcard.com/badge/github.com/devopscorner/golang-adot/src)](https://goreportcard.com/badge/github.com/devopscorner/golang-adot/src)
![all contributors](https://img.shields.io/github/contributors/devopscorner/golang-adot)
![tags](https://img.shields.io/github/v/tag/devopscorner/golang-adot?sort=semver)
[![docker pulls](https://img.shields.io/docker/pulls/devopscorner/bookstore-adot.svg)](https://hub.docker.com/r/devopscorner/bookstore-adot/)
Expand Down
2 changes: 1 addition & 1 deletion docs/reproduce-06-provisioning-resources-eks.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

ADOT (AWS Distro for OpenTelemetry) Implementation for Simple Golang RESTful API Application (Bookstore)

[goreport](https://goreportcard.com/badge/github.com/devopscorner/golang-adot/src)
[![goreport](https://goreportcard.com/badge/github.com/devopscorner/golang-adot/src)](https://goreportcard.com/badge/github.com/devopscorner/golang-adot/src)
![all contributors](https://img.shields.io/github/contributors/devopscorner/golang-adot)
![tags](https://img.shields.io/github/v/tag/devopscorner/golang-adot?sort=semver)
[![docker pulls](https://img.shields.io/docker/pulls/devopscorner/bookstore-adot.svg)](https://hub.docker.com/r/devopscorner/bookstore-adot/)
Expand Down
2 changes: 1 addition & 1 deletion docs/reproduce-07-provisioning-resources-amp.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

ADOT (AWS Distro for OpenTelemetry) Implementation for Simple Golang RESTful API Application (Bookstore)

[goreport](https://goreportcard.com/badge/github.com/devopscorner/golang-adot/src)
[![goreport](https://goreportcard.com/badge/github.com/devopscorner/golang-adot/src)](https://goreportcard.com/badge/github.com/devopscorner/golang-adot/src)
![all contributors](https://img.shields.io/github/contributors/devopscorner/golang-adot)
![tags](https://img.shields.io/github/v/tag/devopscorner/golang-adot?sort=semver)
[![docker pulls](https://img.shields.io/docker/pulls/devopscorner/bookstore-adot.svg)](https://hub.docker.com/r/devopscorner/bookstore-adot/)
Expand Down
2 changes: 1 addition & 1 deletion docs/reproduce-08-provisioning-resources-amg.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

ADOT (AWS Distro for OpenTelemetry) Implementation for Simple Golang RESTful API Application (Bookstore)

[goreport](https://goreportcard.com/badge/github.com/devopscorner/golang-adot/src)
[![goreport](https://goreportcard.com/badge/github.com/devopscorner/golang-adot/src)](https://goreportcard.com/badge/github.com/devopscorner/golang-adot/src)
![all contributors](https://img.shields.io/github/contributors/devopscorner/golang-adot)
![tags](https://img.shields.io/github/v/tag/devopscorner/golang-adot?sort=semver)
[![docker pulls](https://img.shields.io/docker/pulls/devopscorner/bookstore-adot.svg)](https://hub.docker.com/r/devopscorner/bookstore-adot/)
Expand Down
2 changes: 1 addition & 1 deletion docs/reproduce-09-provisioning-resources-opensearch.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

ADOT (AWS Distro for OpenTelemetry) Implementation for Simple Golang RESTful API Application (Bookstore)

[goreport](https://goreportcard.com/badge/github.com/devopscorner/golang-adot/src)
[![goreport](https://goreportcard.com/badge/github.com/devopscorner/golang-adot/src)](https://goreportcard.com/badge/github.com/devopscorner/golang-adot/src)
![all contributors](https://img.shields.io/github/contributors/devopscorner/golang-adot)
![tags](https://img.shields.io/github/v/tag/devopscorner/golang-adot?sort=semver)
[![docker pulls](https://img.shields.io/docker/pulls/devopscorner/bookstore-adot.svg)](https://hub.docker.com/r/devopscorner/bookstore-adot/)
Expand Down
2 changes: 1 addition & 1 deletion docs/reproduce-10-provisioning-resources-eks-adot-collector.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

ADOT (AWS Distro for OpenTelemetry) Implementation for Simple Golang RESTful API Application (Bookstore)

[goreport](https://goreportcard.com/badge/github.com/devopscorner/golang-adot/src)
[![goreport](https://goreportcard.com/badge/github.com/devopscorner/golang-adot/src)](https://goreportcard.com/badge/github.com/devopscorner/golang-adot/src)
![all contributors](https://img.shields.io/github/contributors/devopscorner/golang-adot)
![tags](https://img.shields.io/github/v/tag/devopscorner/golang-adot?sort=semver)
[![docker pulls](https://img.shields.io/docker/pulls/devopscorner/bookstore-adot.svg)](https://hub.docker.com/r/devopscorner/bookstore-adot/)
Expand Down
Loading

0 comments on commit cf8700d

Please sign in to comment.