Fix formatting in docs (#379)
This commit is contained in:
@@ -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
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||

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

|
||||
|
||||
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.
|
||||
|
||||

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

|
||||
|
||||
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.
|
||||
|
||||

|
||||
|
||||
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.
|
||||
|
||||

|
||||
|
||||
@@ -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
|
||||
```
|
||||
|
||||
@@ -30,13 +28,13 @@ 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
|
||||
```
|
||||
|
||||
@@ -44,13 +42,13 @@ docker-compose down
|
||||
|
||||
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>
|
||||
```
|
||||
|
||||
@@ -58,7 +56,7 @@ docker-compose run rails bundle exec rspec spec/<path-to-file>:<line-number>
|
||||
|
||||
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
|
||||
```
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user