Skip to content

Commit

Permalink
Documentation clean up [skip ci] (#2011)
Browse files Browse the repository at this point in the history
* Remove doc/setup-{osx,ubuntu}.md
* Deprecate workbench Applogic & Peatio-trading-ui

closes #2010
  • Loading branch information
ysv authored and Louis committed Jan 22, 2019
1 parent 274c43e commit 59f9e3e
Show file tree
Hide file tree
Showing 6 changed files with 27 additions and 703 deletions.
15 changes: 7 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,27 @@

### If your problem is with...

- [Workbench](https://github.com/rubykube/workbench)
- [Microkube](https://github.com/rubykube/microkube)
- [Barong](https://github.com/rubykube/barong)
- [AppLogic](https://github.com/rubykube/applogic)
- [Peatio Trading UI](https://github.com/rubykube/peatio-trading-ui)
- Cryptonode e.g [Bitcoind](https://github.com/bitcoin/bitcoin), [Geth](https://github.com/ethereum/go-ethereum),
[Rippled](https://github.com/ripple/rippled), [BitGo](https://www.bitgo.com/)
[Rippled](https://github.com/ripple/rippled), [BitGo](https://www.bitgo.com/)
- [Workbench](https://github.com/rubykube/workbench) (DEPRECATED since 2.0)
- [AppLogic](https://github.com/rubykube/applogic) (NOT SUPPORTED since 2.0)
- [Peatio Trading UI](https://github.com/rubykube/peatio-trading-ui) (NOT SUPPORTED since 1.9)

Then please do not report your issue here - you should instead report it to appropriate repository or organisation.

### For local installation please use...

- [Workbench](https://github.com/rubykube/workbench)
- [Microkube](https://github.com/rubykube/microkube)
- [Minimalistic local development environment with docker-compose](README.md) (Advanced)
- [Minimalistic local development environment with docker-compose](README.md) (ADVANCED)
- [Workbench](https://github.com/rubykube/workbench) (DEPRECATED since 2.0)

Then please open an issue here **ONLY** if you use [Minimalistic local development environment with docker-compose](README.md):

### If your issue is...

- New feature request but it is possible to add this feature in separate service e.g AppLogic, Barong or Custom Frontend.
- New feature request but it is possible to add this feature in separate service using Event or Management API.
- Described in [FAQ section](https://github.com/rubykube/peatio/issues?q=is%3Aissue+is%3Aclosed+label%3AFAQ) (we are working on it now)

Then please don't open new issue here.
Expand Down Expand Up @@ -84,7 +84,6 @@ Your PR will be reviewed by the project maintainers and community, before being

It's mandatory to cover your code with tests!


## Coding Style

We hope to introduce this section soon.
41 changes: 15 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ issues, fixes, and patches to this project.

We advice to use [minimalistic environment](#minimalistic-local-development-environment-with-docker-compose) if you want to develop only Peatio and don't touch processes which interact with other components.

Otherwise we advice to use [workbench based environment](#local-development-environment-with-workbench)
Otherwise we advice to use [microkube based environment](#local-development-environment-with-microkube)

### Minimalistic local development environment with docker-compose:

Expand All @@ -78,7 +78,7 @@ Otherwise we advice to use [workbench based environment](#local-development-envi

## Installation

### Local development without workbench
### Local development without microkube

1. Set up initial configuration `./bin/setup`
2. Start peatio daemons `god -c lib/daemons/daemons.god`
Expand All @@ -90,37 +90,26 @@ Otherwise we advice to use [workbench based environment](#local-development-envi
```
4. Start rails server `JWT_PUBLIC_KEY=$(cat config/secrets/rsa-key.pub| base64 -w0) rails s -b0.0.0.0`

### Local development environment with workbench:
### Local development environment with microkube:

We suggest you to start using Peatio by installing [Workbench](https://github.com/rubykube/workbench). [Workbench](https://github.com/rubykube/workbench) which is based on [Docker containers](https://www.docker.com/what-docker) is a convenient and straightforward way to start Peatio development environment.
We suggest you to start using Peatio by installing [Microkube](https://github.com/rubykube/microkube).
[Microkube](https://github.com/rubykube/microkube) which is based on
[Docker containers](https://www.docker.com/what-docker) is a convenient and straightforward way to start
Peatio development environment.

#### Prerequisites
* [Docker](https://docs.docker.com/install/) installed
* [Docker compose](https://docs.docker.com/compose/install/) installed

#### Prepare the workbench
#### Prepare the microkube

1. Recursive clone : `git clone --recursive https://github.com/rubykube/workbench.git`
2. Move to workbench `cd workbench`
3. Build the images: `make build`
4. Run the application: `make run`
Follow microkube [README](https://github.com/rubykube/microkube) for the best Peatio installation experience.

You should add those hosts to your `/etc/hosts` file:
### Local development environment with workbench (DEPRECATED since 2.0):

```
0.0.0.0 api.wb.local
0.0.0.0 auth.wb.local
0.0.0.0 api.slanger.wb.local
0.0.0.0 ws.slanger.wb.local
0.0.0.0 pma.wb.local
0.0.0.0 monitor.wb.local
0.0.0.0 btc.wb.local
0.0.0.0 eth.wb.local
```
Now you have peatio up and running.
[Workbench](https://github.com/rubykube/workbench) is legacy way for running Peatio locally.
Probably Workbench support will be removed soon. We advice to use [Microkube](https://github.com/rubykube/microkube)
which is more lightweight environment.

#### [Barong](https://github.com/rubykube/barong)

Expand Down Expand Up @@ -166,8 +155,8 @@ After all of that you can start using Peatio in your browser just by following o

You can interact with Peatio through API:

* API v2
* Management API v1
* Account, Market & Public API v2
* Management API v2
* Websocket API
* Event API (AMQP)

Expand Down
2 changes: 1 addition & 1 deletion config/application.rb
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ class Application < Rails::Application
config.active_record.raise_in_transactional_callbacks = true

# Configure relative url root by setting URL_ROOT_PATH environment variable.
# Used by workbench with API Gateway.
# Used by microkube with API Gateway.
config.relative_url_root = ENV.fetch('URL_ROOT_PATH', '/')

config.assets.initialize_on_precompile = true
Expand Down
14 changes: 4 additions & 10 deletions docs/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Components managed by bosh are:
* RabbitMQ
* Prometheus with Grafana for monitoring

[Bosh project](http://bosh.io/)
[Bosh project](https://bosh.io/)

#### Vault

Expand Down Expand Up @@ -82,18 +82,12 @@ Our goal and roadmap is to provide advanced API endpoints in order to be able to

[Peatio project](https://github.com/rubykube/peatio)

#### Peatio Workbench
#### Peatio Microkube

Peatio workbench is the recommended development, test and integration environment for new developers.
Peatio microkube is the recommended development, test and integration environment for new developers.

[Peatio Workbench](https://github.com/rubykube/peatio-workbench)
[Peatio Microkube](https://github.com/rubykube/microkube)

#### Peatio SDK

Peatio SDK is a javascript SDK we maintain for running QA Test scenarios.
Use Peatio SDK to interact with the server side backends such as Peatio and Barong.

[Peatio SDK](https://github.com/rubykube/peatio-workbench)

#### Coinhub

Expand Down
Loading

0 comments on commit 59f9e3e

Please sign in to comment.