Skip to content

Commit

Permalink
Merge pull request gofr-dev#757 from gofr-dev/fix-typos
Browse files Browse the repository at this point in the history
Fix typos in docs
  • Loading branch information
vikash authored Jun 26, 2024
2 parents 2e24b5a + af1351b commit 401c967
Show file tree
Hide file tree
Showing 9 changed files with 18 additions and 15 deletions.
4 changes: 4 additions & 0 deletions docs/advanced-guide/gofr-errors/page.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ automatically handle HTTP status code selection. These include:
- `ErrorInvalidParam`: Represents an error due to an invalid parameter.
- `ErrorMissingParam`: Represents an error due to a missing parameter.
- `ErrorEntityNotFound`: Represents an error due to a not found entity.
- `ErrorEntityAlreadyExist`: Represents an error due to creation of duplicate entity.
- `ErrorInvalidRoute`: Represents an error for invalid route.
- `ErrorRequestTimeout`: Represents an error for request which timed out.
- `ErrorPanicRecovery`: Represents an error for request which panicked.

#### Usage:
To use the predefined http errors,users can simply call them using GoFr's http package:
Expand Down
4 changes: 2 additions & 2 deletions docs/advanced-guide/handling-file/page.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Handling File

Gofr simplifies the complexity of working with different filestores by offering a uniform API. This allows developers to interact with different storage systems using the same set of methods, without needing to understand the underlying implementation details of each filestore.
GoFr simplifies the complexity of working with different file stores by offering a uniform API. This allows developers to interact with different storage systems using the same set of methods, without needing to understand the underlying implementation details of each file store.

## USAGE

Expand Down Expand Up @@ -82,4 +82,4 @@ err := c.File.RemoveAll("my_dir/my_text")
```


> Errors have been skipped in the example to focus on the core logic, it is recommended to handle all the errors.
> Errors have been skipped in the example to focus on the core logic, it is recommended to handle all the errors.
4 changes: 2 additions & 2 deletions docs/advanced-guide/overriding-default/page.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Response example:

## Favicon.ico

By default GoFr load its own `favicon.ico` present in root directory for an application. To override `favicon.ico` user
By default, GoFr load its own `favicon.ico` present in root directory for an application. To override `favicon.ico` user
can place its custom icon in the **static** directory of its application.

> NOTE: The custom favicon should also be named as `favicon.ico` in the static directory of application.
> NOTE: The custom favicon should also be named as `favicon.ico` in the static directory of application.
2 changes: 1 addition & 1 deletion docs/advanced-guide/swagger-documentation/page.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ GoFr will automatically render the Swagger documentation at the `/.well-known/sw
Here are the steps:

- Create an `openapi.json` file that describes your API according to the OpenAPI specification.
- Place the `openapi.json` file inside the static directory in your project.
- Place the `openapi.json` file inside the `static` directory in your project.
- Start your GoFr server.
- Navigate to `/.well-known/swagger` on your server’s URL.

Expand Down
4 changes: 2 additions & 2 deletions docs/quick-start/configuration/page.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

GoFr simplifies configuration management by reading configuration via environment variables.
Application code is decoupled from how configuration is managed as per the {%new-tab-link title="12-factor" href="https://12factor.net/config" %}.
Configs in GoFr can be used to initialise datasources, tracing , setting log levels, changing default HTTP or metrics port.
Configs in GoFr can be used to initialise datasources, tracing, setting log levels, changing default HTTP or metrics port.
This abstraction provides a user-friendly interface for configuring user's application without modifying the code itself.

To set configs create a `configs` directory in the project's root and add `.env` file.
Expand Down Expand Up @@ -44,4 +44,4 @@ APP_ENV=dev go run main.go
```


This approach ensures that the correct configurations are used for each environment, providing flexibility and control over the application's behavior in different contexts.
This approach ensures that the correct configurations are used for each environment, providing flexibility and control over the application's behavior in different contexts.
2 changes: 1 addition & 1 deletion docs/quick-start/connecting-mysql/page.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Just like Redis GoFr also supports connection to SQL(MySQL and Postgres) databas

## Setup

Users can run MySQL and create a database locally using the following docker command:
Users can run MySQL and create a database locally using the following Docker command:

```bash
docker run --name gofr-mysql -e MYSQL_ROOT_PASSWORD=root123 -e MYSQL_DATABASE=test_db -p 3306:3306 -d mysql:8.0.30
Expand Down
8 changes: 4 additions & 4 deletions docs/quick-start/observability/page.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ a request as it travels through your distributed system by simply looking at the
GoFr has support for following trace-exporters:
#### 1. [Zipkin](https://zipkin.io/):

To see the traces install zipkin image using the following docker command:
To see the traces install zipkin image using the following Docker command:

```bash
docker run --name gofr-zipkin -p 2005:9411 -d openzipkin/zipkin:latest
Expand All @@ -188,7 +188,7 @@ DB_NAME=test_db
DB_PORT=3306
# tracing configs
TRACE_EXPORTER=zipkin
TRACE_EXPORTER=zipkin
TRACER_HOST=localhost
TRACER_PORT=2005
Expand All @@ -203,7 +203,7 @@ Open {% new-tab-link title="zipkin" href="http://localhost:2005/zipkin/" /%} and

#### 2. [Jaeger](https://www.jaegertracing.io/):

To see the traces install jaeger image using the following docker command:
To see the traces install jaeger image using the following Docker command:

```bash
docker run -d --name jaeger \
Expand All @@ -227,7 +227,7 @@ TRACER_PORT=14317
Open {% new-tab-link title="zipkin" href="http://localhost:16686/trace/" /%} and search by TraceID (correlationID) to see the trace.
{% figure src="/jaeger-traces.png" alt="Jaeger traces" /%}

#### 3. [GoFr Tracer](https://tracer.gofr.dev/)
#### 3. [GoFr Tracer](https://tracer.gofr.dev/):

GoFr tracer is GoFr's own custom trace exporter as well as collector. You can search a trace by its TraceID (correlationID)
in GoFr's own tracer service available anywhere, anytime.
Expand Down
3 changes: 1 addition & 2 deletions docs/references/configs/page.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# GoFr Configuration Options

This document lists all the configuration options supported by the Gofr framework. The configurations are grouped by category for better organization.
This document lists all the configuration options supported by the GoFr framework. The configurations are grouped by category for better organization.

## App

Expand Down Expand Up @@ -301,4 +301,3 @@ This document lists all the configuration options supported by the Gofr framewor
- Quality of Service Level

{% /table %}

2 changes: 1 addition & 1 deletion docs/references/context/page.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ GoFr context is an object injected by the GoFr handler. It contains all the requ
request-response cycle a new context is created. The request can be either an HTTP request, GRPC call or
a message from Pub-Sub.
GoFr Context also embeds the **_container_** which maintains all the dependencies like databases, logger, HTTP service clients,
, metrics manager, etc. This reduces the complexity of the application as users don't have to maintain and keep track of
metrics manager, etc. This reduces the complexity of the application as users don't have to maintain and keep track of
all the dependencies by themselves.

GoFr context is an extension of the go context, providing a wrapper around the request and response providing
Expand Down

0 comments on commit 401c967

Please sign in to comment.