Skip to content

Commit

Permalink
Fix: typos (#971)
Browse files Browse the repository at this point in the history
* Fix: typo

* Fix: typos
  • Loading branch information
omahs authored Sep 5, 2023
1 parent 6b267ac commit f2d12be
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ Connects all the services together. The compose file is pretty straightforward a
If you are altering these settings make sure you are in sync with your `.yml` configuration file.

#### Local RPC node
A typical problem is to access service running on the host machine from inside a docker container. Currently there's no unversal (cross-platform) way to do it (should be fixed in docker 20). A suggested way is the following:
A typical problem is to access service running on the host machine from inside a docker container. Currently there's no universal (cross-platform) way to do it (should be fixed in docker 20). A suggested way is the following:

1. Expose your node at `172.17.0.1:8732` (docker gateway)
2. For each docker service that needs to access RPC add to compose file:
Expand Down Expand Up @@ -170,4 +170,4 @@ About env files: https://docs.docker.com/compose/env-file/
* `AWS_SECRET_ACCESS_KEY`

#### Others
* `STABLE_TAG` _required for building & running images_ e.g. _2.5_
* `STABLE_TAG` _required for building & running images_ e.g. _2.5_
8 changes: 4 additions & 4 deletions docs/developer.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
BCDHub is a set of microservices written in Golang:

* `indexer`
Loads and decodes operations related to smart contracts and also keeps track of the block chain and handles protocol updates.
Loads and decodes operations related to smart contracts and also keeps track of the blockchain and handles protocol updates.
* `API`
Exposes RESTful JSON API for accessing indexed data (with on-the-fly decoding). Also provides a set of methods for authentication and managing user profiles.

Expand All @@ -17,12 +17,12 @@ BCDHub also depends on several API endpoints exposed by [TzKT](https://github.co
* Mempool operations
* Contract aliases and other metadata

Those services are obviously make sense for public networks only and not used for sandbox or other private environments.
Those services obviously make sense for public networks only and not used for sandbox or other private environments.

## Versioning
BCD uses `X.Y.Z` version format where:
* `X` changes every 3-5 months along with a big release with a significant addition of functionality
* `Y` increasing signals about a possibly non-compatible update that requires reindexing (or restoring from snaphot) or syncing with frontend
* `Y` increasing signals about a possibly non-compatible update that requires reindexing (or restoring from snapshot) or syncing with frontend
* `Z` bumped for every stable release candidate or hotfix

### Syncing with frontend
Expand Down Expand Up @@ -206,4 +206,4 @@ Select the snapshot you made.
#### 3. Run the rest of the services
```
make stable
```
```

0 comments on commit f2d12be

Please sign in to comment.