Skip to content

Commit

Permalink
fix(docs): fix links and typos in docs (#192)
Browse files Browse the repository at this point in the history
  • Loading branch information
bsushmith authored Jun 24, 2022
1 parent cfc854f commit 1c653a7
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 11 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,14 +116,14 @@ $ git clone [email protected]:odpf/guardian.git
# Install all the golang dependencies
$ make install

# Check all build comamnds available
# Check all build commands available
$ make help

# Build meteor binary file
$ make build

# Init config
$ cp app/config.yaml config.yaml
$ cp internal/server/config.yaml config.yaml
$ ./guardian config init

# Run database migrations
Expand Down
6 changes: 3 additions & 3 deletions docs/docs/concepts/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Guardian CLI will be able to can start a service that controls all that Guardian

#### Guardian Service

Guardian service exposes few REST endpoints that can be used with simple curl request for registering or updaing a provider, creating and granting/revoking appeals or checking the status of a appeal, creating policies etc.
Guardian service exposes few REST endpoints that can be used with simple curl request for registering or updating a provider, creating and granting/revoking appeals or checking the status of a appeal, creating policies etc.

#### Guardian Scheduler

Expand All @@ -28,8 +28,8 @@ Provider once registered needs to be stored somewhere as a source of truth. Guar

Guardian itself doesn't govern how a appeal will be executed. It only provides the building blocks. A provider for any resource type needs to be build and integrated with Guardian in order to support it's access flow. Any provider has 4 components

- Config - This defines the permisions and credential configuartion of a resource.
- Client - This defines the client configuartions and methods.
- Config - This defines the permissions and credential configuration of a resource.
- Client - This defines the client configurations and methods.
- Provider - This deals with the interaction with a provider.
- Resource - This defines all the resources and functions associated with them.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/contribute/contribution.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ We are always interested in adding new maintainers. What we look for is a series
* Maintainers will have write access to the Guardian repository.
* There is no strict protocol for becoming a maintainer. Candidates for new maintainers are typically people that are active contributors and community members.
* Candidates for new maintainers can also be suggested by current maintainers.
* If you would like to become a maintainer, you should start contributing to Guardian in any of the ways mentioned. Youc might also want to talk to other maintainers and ask for their advice and guidance.
* If you would like to become a maintainer, you should start contributing to Guardian in any of the ways mentioned. You might also want to talk to other maintainers and ask for their advice and guidance.

## Guidelines

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/guides/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -288,7 +288,7 @@ provider updated

## Resources command

Resources command allows us to list and set metadat of resoirces.
Resources command allows us to list and set metadata of resources.

* **What is inside?**

Expand Down
8 changes: 4 additions & 4 deletions docs/docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Users are required to raise an appeal in order to gain access to a particular re

Explore the following resoruces to get started with Guardian:

- [Guides](https://odpf.gitbook.io/guardian/guides/overview) provides guidance on usage.
- [Concepts](https://odpf.gitbook.io/guardian/concepts/architecture) describes all important Guardian concepts including system architecture.
- [Reference](https://odpf.gitbook.io/guardian/reference/overview) contains details about configurations and other aspects of Guardian.
- [Contribute](https://odpf.gitbook.io/guardian/contribute/contribution) contains resources for anyone who wants to contribute to Guardian.
- [Guides](https://odpf.github.io/guardian/docs/guides/overview) provides guidance on usage.
- [Concepts](https://odpf.github.io/guardian/docs/concepts/architecture) describes all important Guardian concepts including system architecture.
- [Reference](https://odpf.github.io/guardian/docs/reference/glossary) contains details about configurations and other aspects of Guardian.
- [Contribute](https://odpf.github.io/guardian/docs/contribute/contribution) contains resources for anyone who wants to contribute to Guardian.

0 comments on commit 1c653a7

Please sign in to comment.