Skip to content

Commit

Permalink
Fix formatting in docs (#379)
Browse files Browse the repository at this point in the history
  • Loading branch information
pranavrajs authored and sojan-official committed Dec 23, 2019
1 parent 1143893 commit 32efe86
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 18 deletions.
1 change: 1 addition & 0 deletions docs/README.md
Expand Up @@ -10,6 +10,7 @@ This guide will help you get started with Chatwoot!
* [Mac](/docs/installation-guide-mac-os)
* [Ubuntu](/docs/installation-guide-ubuntu)
* [Windows](/docs/installation-guide-windows)
* [Docker](/docs/installation-guide-docker)

### Project Setup

Expand Down
12 changes: 6 additions & 6 deletions docs/channels/website-channel.md
Expand Up @@ -3,26 +3,26 @@ path: "/docs/channels/website"
title: "How to create website channel?"
---

Step 1. Click on "Add Inbox" button from Settings > Inboxes page.
**Step 1**. Click on "Add Inbox" button from Settings > Inboxes page.

![inbox_create](./images/inbox_create.png)

Step 2. Click on "Website" icon.
**Step 2**. Click on "Website" icon.

![list_of_channels](./images/list_of_channels.png)

Step 3. Provide your website name and url. Website name will be shown on the live chat widget.
**Step 3**. Provide your website name and url. Website name will be shown on the live chat widget.

![create_website](./images/create_website.png)

Step 4. "Add agents" to your website inbox.
**Step 4**. "Add agents" to your website inbox.

![add_agents](./images/add_agents.png)

Step 5. Hooray! You can sucessfully created a website inbox. Copy and paste the code shown in the page to your website and start supporting your customers.
**Step 5**. Hooray! You can sucessfully created a website inbox. Copy and paste the code shown in the page to your website and start supporting your customers.

![finish_inbox](./images/finish_inbox.png)

Step 6. If you want to update the agents who have access to the inbox, you can go to Settings > Inboxes. You will be able to see your website inbox listed there. Click on Settings. You will be able to Code as well the list of agents who have access to the inbox.
**Step 6**. If you want to update the agents who have access to the inbox, you can go to Settings > Inboxes. You will be able to see your website inbox listed there. Click on Settings. You will be able to Code as well the list of agents who have access to the inbox.

![inbox_settings](./images/inbox_settings.png)
22 changes: 10 additions & 12 deletions docs/development/environment-setup/docker.md
Expand Up @@ -3,25 +3,23 @@ path: "/docs/installation-guide-docker"
title: "Docker Setup and Debugging Guide"
---

# Docker Setup and Debugging Guide

## development environment
### Development environment

After cloning the repo and installing docker on your machine, run the following command from the root directory of the project.

```
```bash
docker-compose build
```

After building the image or after destroying the stack you would have to reset the database using following command

```
```bash
docker-compose run rails bundle exec rails db:reset
```

### Running the app

```
```bash
docker-compose run --service-port rails
```

Expand All @@ -30,35 +28,35 @@ docker-compose run --service-port rails

you can also use the below command instead to run the app and see the full logs.

```
```bash
docker-compose up
```

### Destroying the complete composer stack

```
```bash
docker-compose down
```

### Running rspec tests

For running the complete rspec tests

```
```bash
docker-compose run rails bundle exec rspec
```

For running specific test:

```
```bash
docker-compose run rails bundle exec rspec spec/<path-to-file>:<line-number>
```

## production environment

Sometimes you might want to debug the production build locally. You would first need to set `SECRET_KEY_BASE` environment variable in your .env.example file and then run the below commands:

```
```bash
docker-compose -f docker-compose.production.yaml build
docker-compose -f docker-compose.production.yaml up
```
```

0 comments on commit 32efe86

Please sign in to comment.