Skip to content

Commit

Permalink
Add absolute paths for docs (2600hz#6482)
Browse files Browse the repository at this point in the history
  • Loading branch information
jamesaimonetti committed Apr 15, 2020
1 parent 076dbe0 commit 72e9b7f
Show file tree
Hide file tree
Showing 8 changed files with 641 additions and 1,128 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Some 2600Hz specifics:
```erlang
-spec foo(any()) -> any(). % is of no use to anyone!
```
* Run [dialyzer](./dialyzer.md) on any modules you make changes to, plus any modules your new code makes calls to.
* Run [dialyzer](/doc/engineering/dialyzer.md) on any modules you make changes to, plus any modules your new code makes calls to.
* When creating lists or binaries, drop the comma and next element to a new line
* This includes `-export([...])` directives.
* No:
Expand Down
4 changes: 2 additions & 2 deletions applications/tasks/doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ Task inputs are CSV, JSON data or nothing at all & generate a CSV output.

## APIs

Kazoo Tasks has its own Crossbar module implementing a RESTful API over at [cb_tasks](https://github.com/2600hz/kazoo/blob/master/applications/crossbar/doc/tasks.md).
Kazoo Tasks has its own Crossbar module implementing a RESTful API over at [cb_tasks](/applications/crossbar/doc/tasks.md).

There is also a maintenance module whose entry points are [documented here](./maintenance.md).
There is also a maintenance module whose entry points are [documented here](/applciations/tasks/doc/maintenance.md).

## Task discovery

Expand Down
6 changes: 3 additions & 3 deletions core/kazoo_fixturedb/doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ FixtureDB acts as a central repository for all fixtures which we simply use duri

When writing your EUnit test you can use [_fixture_ test representation](http://erlang.org/doc/apps/eunit/chapter.html#Fixtures) to setup a your test environment by starting a dummy connection to FixtureDB, and cleanup the connection later.

Below is an example with `setup` and `cleanup` method. In `setup()` function we're starting `kazoo_config` applications to read the default [`config-test.ini`](../../../rel/config-test.ini) and then starts the Kazoo data link supervisor. After these steps most of the calls to `kz_datamgr` functions will use FixtureDB (few operations, like view maintenance cleanup, are not implemented).
Below is an example with `setup` and `cleanup` method. In `setup()` function we're starting `kazoo_config` applications to read the default [`config-test.ini`](/rel/config-test.ini) and then starts the Kazoo data link supervisor. After these steps most of the calls to `kz_datamgr` functions will use FixtureDB (few operations, like view maintenance cleanup, are not implemented).

##### Example EUnit Test Using Setup/Cleanup Method

Expand Down Expand Up @@ -79,7 +79,7 @@ View results are exactly the same result sets which `kz_datamgr:get_results/2,3`

FixtureDB acts as database driver for `kazoo_data`, so you need to start `kazoo_config` first to read the database configuration, then start `kazoo_data` connection link by running `kazoo_data_link_sup:start_link()` to bring up Kazoo data connection ETS table. `kazoo_data_link_sup` is a lite version of `kazoo_data_sup` which does not depend on `kazoo_amqp` and tracing capability to be available; its just making a new connection to a database (which in this case is FixtureDB).

OS environment variable `KAZOO_CONFIG` is necessary for `kazoo_config` to read the correct FixtureDB database configuration and by default is set to [`$(ROOT)/rel/config-test.ini`](../../../rel/config-test.ini) in [`kz.mk`](../../../make/kz.mk) file for `test`, `eunit`, `proper` and `fixture_db` targets.
OS environment variable `KAZOO_CONFIG` is necessary for `kazoo_config` to read the correct FixtureDB database configuration and by default is set to [`$(ROOT)/rel/config-test.ini`](/rel/config-test.ini) in [`kz.mk`](/make/kz.mk) file for `test`, `eunit`, `proper` and `fixture_db` targets.

In tests which access the database, you have to bring up `kazoo_config` and `kazoo_data_link_sup`:

Expand Down Expand Up @@ -248,7 +248,7 @@ Better option is use data plan (although you may loose the ability to use those

## FixtureDB Shell Target

There is a target in the root [`Makefile`](../../../Makefile) and [`kz.mk`](../../../make/kz.mk) for start a shell with all core, applications and deps in path and has `KAZOO_CONFIG` set, so you can easily run `kz_fixturedb_util` functions where ever you're in Kazoo project path.
There is a target in the root [`Makefile`](https://github.com/2600hz/kazoo/blob/master/Makefile) and [`kz.mk`](/make/kz.mk) for start a shell with all core, applications and deps in path and has `KAZOO_CONFIG` set, so you can easily run `kz_fixturedb_util` functions where ever you're in Kazoo project path.

```shell
kazoo $ make fixture_shell
Expand Down
8 changes: 4 additions & 4 deletions doc/mkdocs/commercial.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ After on-boarding is completed an account with default setting is setup and read

Before you begin you need to know the main URL path to the API which is usually provided to you by e-mail during on-boarding process. If you don't have this URL you can ask a your reseller salesperson to give you the URL.

Crossbar API requires the request to be authenticated, so you have to first get an authentication token before making any HTTP request to the API. The are various way to get this authentication token, you can learn more about them in [Authenticate your REST requests](applications/crossbar/doc/how_to_authenticate.md).
Crossbar API requires the request to be authenticated, so you have to first get an authentication token before making any HTTP request to the API. The are various way to get this authentication token, you can learn more about them in [Authenticate your REST requests](/applications/crossbar/doc/how_to_authenticate.md).

### Accessing to REST API resources

Expand All @@ -36,7 +36,7 @@ API resources are available at below location:
/{VERSION}/accounts/{ACCOUNT_ID}/resources/{RESOURCE_ID}
```

To learn about URL structure read [REST API Basics](applications/crossbar/doc/basics.md#basic-uri-structure).
To learn about URL structure read [REST API Basics](/applications/crossbar/doc/basics.md#basic-uri-structure).

But for now we assume we want to get out own account settings. For doing this we can simply use this cURL command:

Expand Down Expand Up @@ -102,8 +102,8 @@ Your response maybe be different from this example, since it depends on your acc

Learn more about Crossbar APIs:

* Read [REST API Basics](applications/crossbar/doc/basics.md) to know more about Crossbar REST API.
* How to [Authenticate your REST requests](applications/crossbar/doc/how_to_authenticate.md).
* Read [REST API Basics](/applications/crossbar/doc/basics.md) to know more about Crossbar REST API.
* How to [Authenticate your REST requests](/applications/crossbar/doc/how_to_authenticate.md).
* Explore resources provided by REST APIs from this documentation.

Most of the resources are expected to have input (and some don't, read their documentation carefully to know how to work with them) which are explained in JSON-Schema form. In each resource documentation there is section explaining their schema.
Loading

0 comments on commit 72e9b7f

Please sign in to comment.