Browse Source

Improving English Documentation
完善英文文档

star7th 6 years ago
parent
commit
85cd835350

+ 6 - 3
README.md

@@ -59,10 +59,13 @@ ShowDoc is a tool greatly applicable for an IT team to share documents online. I
    
 
 ### Deploy It to Your Own Server
- - ShowDoc Deploy Manual
-  
-     Please refer to:[documentation/en/DeployManual.md](documentation/en/DeployManual.md)
+ - ShowDoc Deploy
   
+     Please refer to: [AutoInstall.md](https://github.com/star7th/showdoc/blob/master/documentation/en/AutoInstall.md)
+
+ - Development & Contribution
+
+   Please refer to: [Development&Contribution.md](https://github.com/star7th/showdoc/blob/master/documentation/en/Development&Contribution.md)
 
 ### Copyright 
 

+ 10 - 3
documentation/en/AutoInstall.md

@@ -1,9 +1,9 @@
 ### Foreword
  The automatic script script uses Docker to install the runtime environment for Linux servers. If your server does not have a Docker service, the script will try to install it. The process of installing Docker may be a bit slow. If you have already installed docker, the script will omit some of the steps to speed up the ShowDoc installation.
  
-When the script fails to install Docker, you can manually install Docker before executing the script. If you still have Docker installed, you can (un/re-)install and debug it step by step according to this tutorial: https://www.showdoc.cc/help?page_id=65610
+When the script fails to install Docker, you can manually install Docker before executing the script. If you still have Docker installed, you can (un/re-)install and debug it step by step according to this tutorial: [ByDocker.md](https://github.com/star7th/showdoc/blob/master/documentation/en/ByDocker.md)
 
-If the server system itself does not support Docker, you can only run ShowDoc by manually installing the PHP environment: https://www.showdoc.cc/help?page_id=13732
+If the server system itself does not support Docker, you can only run ShowDoc by manually installing the PHP environment:  [DeployManual.md](https://github.com/star7th/showdoc/blob/master/documentation/en/DeployManual.md)
 
 
 ### Instructions
@@ -28,6 +28,10 @@ You can open ShowDoc by opening http://your-domain.com:4999 (replace your-domain
 
 For issues or suggestions on ShowDoc, please go to https://github.com/star7th/showdoc for an issue.
 
+### Development & Contribution
+
+Please refer to: [Development&Contribution.md](https://github.com/star7th/showdoc/blob/master/documentation/en/Development&Contribution.md)
+
 
 ### Upgrade from manual mode to automatic script mode
 If you have previously installed ShowDoc manually, consider upgrading to this automatic scripting method. After upgrading to the script mode, you can use the automation features of the script, such as upgrading to the latest version, restarting, uninstalling, and so on.
@@ -42,8 +46,11 @@ Upgrade method:
  ```
  Chmod 777 -R /showdoc_data/html
  ./showdoc update
+
  ```
- 
+
+
+
  
 ### Other commands
 

+ 1 - 1
documentation/en/ByDocker.md

@@ -6,7 +6,7 @@ Make sure your environment has Docker installed before installation. The Docker
 # The original official image installation command (Chinese mainland users do not recommend direct use of the original image, you can use the following accelerated image)
 Docker pull star7th/showdoc
 
-# Image Installation Command (Remember to execute the Docker tag command after installation to rename)
+# Chinese Image Installation Command (Remember to execute the Docker tag command after installation to rename)
 Docker pull registry.docker-cn.com/star7th/showdoc
 Docker tag registry.docker-cn.com/star7th/showdoc:latest star7th/showdoc:latest
 

+ 8 - 7
documentation/en/DeployManual.md

@@ -12,11 +12,11 @@
 
 - #### New installation
  
- - If you are familiar with the command line, you can install ShowDoc [by Composer](ByComposer.md "by Composer").
-  Or manually download the code from https://github.com/star7th/showdoc/releases
+ - Manually download the code from https://github.com/star7th/showdoc/
  
  - Make these writable
- Example: `sudo chmod -R 777 server/showdoc/install
+
+  Example: `sudo chmod -R 777 server/showdoc/install`
   
   `/install`, `/Application/Runtime ` ,`/Public/Uploads`,`/Sqlite`,`/Sqlite/showdoc.db.php`
    
@@ -28,13 +28,14 @@
  
      `http://your-domain.com/install/`
    
- -  Default Admin Username : showdoc
-                  Password : 123456
+ -  Default Admin 
+
+   Username : showdoc
+   Password : 123456
    
 - #### Upgrade 
 
- - If you are familiar with the command line, you can update ShowDoc [by Composer](http://www.showdoc.cc/help-en?page_id=32344 "by Composer").
-  Or manually download the code from https://github.com/star7th/showdoc/releases
+ - Manually download the code from https://github.com/star7th/showdoc/
  - Backup your codes via: `mv showdoc  showdoc_backup`
  - Dowload new codes and decompression it to a new directory.Copy `/Sqlite/*` and `/Public/Uploads/*` from old directory to new directory
  

+ 16 - 0
documentation/en/Development&Contribution.md

@@ -1,28 +1,38 @@
 #### Technical stack description
 
 Frontend: Vue + ElementUI
+
 Backend: In order to be compatible with the low-level php runtime environment (compatible with 5.3), the conservative ThinkPHP 3.2.3 framework is used.
+
 Database: ShowDoc comes with a file database (/Sqlite/showdoc.db.php), no need to manually install the database
 
 #### Preparation before development
 
 Developing a machine requires first installing the PHP environment and the NodeJS environment.
 Download the code and place it in the www directory under the PHP environment
+
 First access in the browser through the address, in order to complete the initial installation of ShowDoc (if it has been installed, ignore it)
+
 Go to ShowDoc's web_src directory on the command line and execute npm install to install the dependencies. (If there is no npm, you must first install the NodeJS environment)
 
 
 #### Front-end development
 
 Execute npm run dev to enable the mode, and you can see the effect of the changes in real time by accessing localhost:8080. Please use a proxy to proxy to the PHP server when requesting the backend API.
+
 The npm run build needs to be executed before the final package takes effect. The packaged static files will be in the /web directory.
 
 Mainly related to the directories and files:
+
 ```
 Web_src/src/components //page components are basically placed here
+
 Web_src/src/router // page routing. Can target components based on url
+
 Web_src/static // static resource directory
+
 Web_src/static/lang // front-end language pack
+
 ```
 
 #### Backend development
@@ -30,10 +40,15 @@ Web_src/static/lang // front-end language pack
 Mainly related directories and files
 
 ```
+
 Server/Application/Api/ //Application directory, basically all background apis are placed here
+
 Server/Application/Runtime/Logs //If there is an error log, it will print out the browser directly or print it here.
+
 Public/Uploads //The uploaded image is placed here
+
 Server/Application/Api/Lang //Backend language pack
+
 ```
 
 
@@ -41,4 +56,5 @@ Server/Application/Api/Lang //Backend language pack
 
 Please respect the open-source agreement after the second development, retain the copyright-logo and link
 If you have developed useful features, you may wish to contribute to the official GitHub code repository for sharing with everyone.
+
 The upgrade of ShowDoc may overwrite your original secondary development. If you want to be compatible, it is best to submit it to the official warehouse to become an official function.

+ 6 - 2
documentation/en/README.md

@@ -59,9 +59,13 @@ ShowDoc is a tool greatly applicable for an IT team to share documents online. I
    
 
 ### Deploy It to Your Own Server
- - ShowDoc Deploy Manual
+ - ShowDoc Deploy
   
-     Please refer to:[DeployManual.md](DeployManual.md)
+     Please refer to: [AutoInstall.md](https://github.com/star7th/showdoc/blob/master/documentation/en/AutoInstall.md)
+
+ - Development & Contribution
+
+   Please refer to: [Development&Contribution.md](https://github.com/star7th/showdoc/blob/master/documentation/en/Development&Contribution.md)
   
 
 ### Copyright