From f2929db8009be38d6d92ece151c52830f51ae018 Mon Sep 17 00:00:00 2001 From: Pranav Raj Sreepuram Date: Mon, 23 Dec 2019 12:43:39 +0530 Subject: [PATCH] Fix formatting in docs --- docs/README.md | 1 + docs/channels/website-channel.md | 12 +++++------ docs/development/environment-setup/docker.md | 22 +++++++++----------- 3 files changed, 17 insertions(+), 18 deletions(-) diff --git a/docs/README.md b/docs/README.md index 2e1ade6694bc..7deb90f89248 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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 diff --git a/docs/channels/website-channel.md b/docs/channels/website-channel.md index 1eb5a492cec6..5d6f0ed2f711 100644 --- a/docs/channels/website-channel.md +++ b/docs/channels/website-channel.md @@ -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) diff --git a/docs/development/environment-setup/docker.md b/docs/development/environment-setup/docker.md index 20e4cf3e6fb0..28f87b185a6e 100644 --- a/docs/development/environment-setup/docker.md +++ b/docs/development/environment-setup/docker.md @@ -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/: ``` @@ -58,7 +56,7 @@ docker-compose run rails bundle exec rspec spec/: 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 -``` \ No newline at end of file +```