This is an automated email from the ASF dual-hosted git repository.
fenbox pushed a commit to branch build-community
in repository https://gitbox.apache.org/repos/asf/incubator-answer-website.git
The following commit(s) were added to refs/heads/build-community by this push:
new f3e672bd docs: fix format
f3e672bd is described below
commit f3e672bdf2998be45e9c88e0a36e3b5c62e19c74
Author: fen <[email protected]>
AuthorDate: Mon Nov 20 16:16:45 2023 +0800
docs: fix format
---
docs/getting-started/configfile.md | 3 +--
docs/getting-started/installation.md | 14 ++++++++++----
docs/getting-started/upgrade.md | 15 ++++++++++-----
3 files changed, 21 insertions(+), 11 deletions(-)
diff --git a/docs/getting-started/configfile.md
b/docs/getting-started/configfile.md
index 4ae9a4f0..1e53fb73 100644
--- a/docs/getting-started/configfile.md
+++ b/docs/getting-started/configfile.md
@@ -12,7 +12,7 @@ We use `yaml` configuration file. It will be created
automatically after `answer
## config.yaml description
-```yaml
+```yaml title="/data/conf/config.yaml"
server:
http:
addr: 0.0.0.0:80 # Project access port number
@@ -32,5 +32,4 @@ swaggerui:
service_config:
secret_key: "answer" # encryption key
upload_path: "/data/uploads" # upload directory
-
```
diff --git a/docs/getting-started/installation.md
b/docs/getting-started/installation.md
index 6cdea9e0..66997292 100644
--- a/docs/getting-started/installation.md
+++ b/docs/getting-started/installation.md
@@ -4,7 +4,7 @@ slug: /installation
# Installation
-## 🚀 Start Answer
+## Start Answer
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
@@ -12,12 +12,14 @@ import TabItem from '@theme/TabItem';
There are multiple ways to start Answer, you can choose the one that suits you
best.
<Tabs>
- <TabItem value="docker-compose" label="Docker Compose" default>
+ <TabItem value="docker-compose" label="Docker compose" default>
We recommend using Docker Compose to run Answer. This is the easiest way to
get started with Answer.
:::tip
+
If you are using [Docker
Desktop](https://www.docker.com/products/docker-desktop) on Windows or Mac,
docker-compose is already included. If you are using Linux, you will need to
install docker-compose separately.
+
:::
```bash
@@ -38,7 +40,9 @@ docker run -d -p 9080:80 -v answer-data:/data --name answer
answerdev/answer:lat
After running the command, heading to <http://localhost:9080/install> to
continue installation.
:::tip
+
If you can't access the installation page, you can use the command `docker
logs answer` to view the logs. It may help you find the specific problem.
+
:::
</TabItem>
@@ -69,7 +73,7 @@ We use `-C` flag to indicate the directory where saved answer
data.
</TabItem>
</Tabs>
-## Install Steps
+## Install steps
> After you start the answer, you can follow the steps below to complete the
> initialization about the basic configuration.
@@ -97,9 +101,11 @@ Click Next button to create the configuration file.
Site URL is the browser address you will use to access answers after
installation.
**Don't forget the admin Email and password.**
:::
+
### Step 5: Complete
-🎉Congratulations, you can click the done button to start your answer journey!
+Congratulations, you can click the done button to start your answer journey!
+
diff --git a/docs/getting-started/upgrade.md b/docs/getting-started/upgrade.md
index 04c189d1..4d15e3c6 100644
--- a/docs/getting-started/upgrade.md
+++ b/docs/getting-started/upgrade.md
@@ -8,12 +8,16 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
:::caution
+
We recommend that you back up database and configuration files before
upgrading. Generally, we guarantee that the upgrade does not affect the
existing data.
+
To back up data means that you have the option to roll back even if the
upgrade fails, or you do not want the advanced version.
+
:::
<Tabs>
<TabItem value="docker-compose" label="Docker Compose" default>
+
If you use docker-compose to install answer, it is very easy to upgrade.
```bash
@@ -22,9 +26,9 @@ docker-compose down
docker-compose up -d
```
-</TabItem>
-
+ </TabItem>
<TabItem value="docker" label="Docker">
+
If you are using docker to install answer, the upgrade steps are as follows.
```bash
@@ -35,16 +39,17 @@ docker run -d -p 9080:80 -v answer-data:/data --name answer
answerdev/answer:lat
```
</TabItem>
-
<TabItem value="binary" label="Binary">
+
If you are using a binary installation of answer, the upgrade steps are as
follows.
-1. Download the latest binary version for your system.
[https://github.com/apache/incubator-answer/releases](https://github.com/apache/incubator-answer/releases)
+1. Download the [latest binary
version](https://github.com/apache/incubator-answer/releases) for your system.
2. Stop old version
3. Execute the upgrade command `./answer upgrade -C ./answer-data/`
4. Run the latest version `./answer run -C ./answer-data/`
-</TabItem>
+
+ </TabItem>
</Tabs>
:::tip
