Skip to content

Commit 400bcb2

Browse files
refactor docs and example (#386)
1 parent 79da85f commit 400bcb2

File tree

4 files changed

+9
-8
lines changed

4 files changed

+9
-8
lines changed

docs/advanced-guide/using-publisher-subscriber/page.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Some of the configurations that are required to configure the PubSub backend tha
2121
that are specific for the type of message broker user wants to use.
2222
`PUBSUB_BACKEND` defines which message broker the application needs to use.
2323

24-
### Kafka
24+
### KAFKA
2525

2626
#### Configs
2727
```dotenv
@@ -52,7 +52,7 @@ docker run -d \
5252
confluentinc/cp-kafka:7.0.1
5353
```
5454

55-
### Google
55+
### GOOGLE
5656

5757
#### Configs
5858
```dotenv
@@ -73,7 +73,7 @@ docker run --name=gcloud-emulator -d -p 8086:8086 \
7373
> **Note**: In Google PubSub only one subscription name can access one topic, framework appends the topic name and subscription name to form the
7474
> unique subscription name on the Google client.
7575
76-
### Mqtt
76+
### MQTT
7777

7878
#### Configs
7979
```dotenv
@@ -101,7 +101,7 @@ docker run -d \
101101
```
102102
> **Note**: find the default mosquitto config file {% new-tab-link title="here" href="https://github.com/eclipse/mosquitto/blob/master/mosquitto.conf" /%}
103103
104-
## Subscribing to Pub/Sub
104+
## Subscribing
105105
Adding a subscriber is similar to adding an HTTP handler, which makes it easier to develop scalable applications,
106106
as it decoupled from the Sender/Publisher.
107107
Users can define a subscriber handler and do the message processing and
@@ -168,7 +168,7 @@ func main() {
168168
}
169169
```
170170

171-
## Publishing to Pub/Sub
171+
## Publishing
172172
The publishing of message is advised to done at the point where the message is being generated.
173173
To facilitate this, user can access the publishing interface from `gofr Context(ctx)` to publish messages.
174174

docs/navigation.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ export const navigation = [
2121
{ title: 'Monitoring Service Health', href: '/docs/advanced-guide/monitoring-service-health' },
2222
{ title: 'Handling Data Migrations', href: '/docs/advanced-guide/handling-data-migrations' },
2323
{ title: 'Writing gRPC Server', href: '/docs/advanced-guide/grpc' },
24-
{ title: 'Using Publisher and Subscriber', href: '/docs/advanced-guide/using-publisher-subscriber' }
24+
{ title: 'Using Pub/Sub', href: '/docs/advanced-guide/using-publisher-subscriber' }
2525
// { title: 'Dealing with Remote Files', href: '/docs/advanced-guide/remote-files' },
2626
// { title: 'Supporting OAuth', href: '/docs/advanced-guide/oauth' },
2727
// { title: 'Creating a Static File Server', href: '/docs/advanced-guide/static-file-server' },

docs/quick-start/introduction/page.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
- Go 1.20 or above.
33
To check the version use the following command `go version`.
44

5-
- Prior familiarity with Golang syntax is essential. [Golang Tour](https://tour.golang.org/) is highly recommended as it has an excellent guided tour.
6-
5+
- Prior familiarity with Golang syntax is essential. {% new-tab-link title="Golang Tour" href="https://tour.golang.org/" /%} is highly recommended as it has an excellent guided tour.
6+
77
## Write your first GoFr API
88

99
Let's start by initializing the go module by using the following command.

examples/using-custom-metrics/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Custom Metrics Example
22

33
This GoFr example demonstrates the use of custom metrics through a simple http server that creates and populate metrics.
4+
GoFr by default pushes metrics to port `2121` on `/metrics` endpoint.
45

56
### To run the example use the command below:
67
```console

0 commit comments

Comments
 (0)