Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs formatting #348

Merged
merged 1 commit into from
Dec 11, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/admin_guide/add_custom_jobs.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ When adding a job, use the following format:

```py
'[name of the task]': {
'task': '[import path of the task]',
'task': '[import path of the task, e.g. tasks_plugin.module.function]',
'schedule': '0 0 * * *', # cron schedule
'args': args,
'kwargs': kwargs,
Expand Down
17 changes: 13 additions & 4 deletions docs/admin_guide/customize_html.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ Querybook allows for some basic customization in the frontend. You can use the w

Right now there are four use cases for custom javascript:

1. Inject trackers such as google analytics. For example:
### Inject trackers such as google analytics.

For example:

```typescript
const script = document.createElement('script');
Expand All @@ -18,7 +20,9 @@ script.innerHTML = `
document.body.appendChild(script);
```

2. Customize some of the messages in Querybook. Currently Querybook allows the plugin to set the following messages:
### Customize some of the messages in Querybook.

Currently Querybook allows the plugin to set the following messages:

```typescript
interface Window {
Expand All @@ -34,8 +38,13 @@ You can set the message directly in the custom_script.ts:
window.NO_ENVIRONMENT_MESSAGE = 'Lorem ipsum dolor sit amet.';
```

3. Customize query result transformation such as adding url link or to transform the text into image. To see the complete guide, please check out [Plugins Guide](../developer_guide/add_query_result_transform.md) on how.
4. Customize the landing page for '/'. You can do so by modifying the window variable with the following type:
### Customize query result transformation.

With result transform, you can dding url link or to transform the text into image. To see the complete guide, please check out [Plugins Guide](../developer_guide/add_query_result_transform.md) on how.

### Customize the landing page.

The landing page is the page shown with the route '/'. You can do so by modifying the window variable with the following type:

```typescript
interface Window {
Expand Down
5 changes: 3 additions & 2 deletions docs/admin_guide/quick_start.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ make

That's it! 🎉

You can now access it on http://localhost:10001

You can now access it on [http://localhost:10001](http://localhost:10001).
See [Setup Guide](setup_guide.md) for more fine grained setup process and configuration.

If the command did not work, checkout [Troubleshoot](troubleshoot.md).
8 changes: 4 additions & 4 deletions docs/admin_guide/setup_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,17 @@ There are two ways to setup Querybook:
1. [Single-Machine Instant Setup (In laptop or server)](quick_start.md)
2. Multi-Machine Setup

The single machine method is a quick way to setup Querybook for <5 users usage and it uses docker-compose to bring up all the necessary databases. Please check `Single Machine Setup` and `Post Setup Configuration` for details.
The single machine method is a quick way to setup Querybook for <5 users usage and it uses docker-compose to bring up all the necessary databases. Please check [Single Machine Setup](quick_start.md) and `Post Setup Configuration` for details.

The multi-machine method allows Querybook to be scaled for hundreds/thousands of users. It is more complicated to setup and requires external databases. Please check `Multi-Machine Setup` and `Post Setup Configuration` for details.
The multi-machine method allows Querybook to be scaled for thousands of users. It is more complicated to setup and requires external databases. Please check [Infra Config](infra_config.md) to see how to setup the infrastructure required to run Querybook.

## Multi-Machine Setup

Once further scalability is desired you can start each service individually in different machines, so you can scale them independently as needed.

#### Step 1: Update your environment variables configuration

See the configuration section for this.
See the [Infra Config](infra_config.md) section for this.

#### Step 2: Start each service individually

Expand All @@ -31,7 +31,7 @@ You can start each service by the following commands:
- Celery worker: `make worker`
- Scheduler: `make scheduler`

If you add `prod_` in front of the service name (for example `make prod_web`), it will start the production version which uses the prod docker image, which has less logging, and no auto-reloading.
If you add `prod_` in front of the service name (for example `make prod_web`), it will start the production version which uses the prod docker image, which has less logging, no auto-reloading, and utilizes uwsgi to handle more requests.

## Post Setup Configuration

Expand Down
2 changes: 1 addition & 1 deletion docs_website/sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
"Admin Guide": [
"admin_guide/quick_start",
"admin_guide/setup_guide",
"admin_guide/general_config",
"admin_guide/infra_config",
"admin_guide/general_config",
"admin_guide/deployment_guide",
"admin_guide/sharing_and_security",
"admin_guide/plugins",
Expand Down