Reduce unnecessary readme.md (#385)

* Reduce unnecessary readme.md

* Revert "Reduce unnecessary readme.md"

This reverts commit 7b4835b.

* Address comments for issue 385

Author: hungry1526

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,28 +1,26 @@
 ---
-name: Bug report
+name: Bug Report
 about: Create a report to help us improve
 title: ''
 labels: ''
 assignees: ''
 
 ---
 
-**Describe the bug**
-A clear and concise description of what the bug is.
+**Description**
+A clear description of the bug
 
-**To Reproduce**
-Steps to reproduce the behavior.
+**Reproduction Steps**
+Detailed steps to reproduce
 
-**Expected behavior**
-A clear and concise description of what you expected to happen.
+**Expected Behavior**
+What you expected to happen.
 
 **Screenshots**
-If applicable, add screenshots to help explain your problem.
 
-**Environment (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
+**Environment (Please complete the following information):**
+ - OS:
+ - Browser:
+ - Version:
 
-**Additional context**
-Add any other context about the problem here.
+**Additional Notes**

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,5 +1,5 @@
 ---
-name: Feature request
+name: Feature Request
 about: Suggest an idea for this project
 title: ''
 labels: ''
@@ -8,13 +8,12 @@ assignees: ''
 ---
 
 **Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+A clear description of the problem
 
 **Describe the solution you'd like**
-A clear and concise description of what you want to happen.
+A clear description of what you want to happen
 
-**Describe alternatives you've considered (This is optional)**
-A clear and concise description of any alternative solutions or features you've considered.
+**Describe alternatives (optional)**
+A clear description of any alternative solutions or features
 
-**Additional context**
-Add any other context or screenshots about the feature request here.
+**Additional Notes**

README.md

@@ -56,7 +56,7 @@ Done predicting. Predict table : iris.predict
 
 ## Contributions
 
-- [Build from source code](doc/build.md).
+- [Build from source](doc/build.md)
 - [The walkthrough of the source code](doc/walkthrough.md)
 - [The choice of parser generator](doc/sql_parser.md)
 

cmd/demo/README.md

@@ -1,8 +1,7 @@
 # Installation
 
 SQLFlow is currently under active development. For those who are interested in trying
-it out, we have provided the instructions and demo. Play around with it. Any bug report and
-issue is welcome. :)
+it out, we have provided the instructions and demo. Play around with it. Any bug report and issue is welcome. :)
 
 
 ## Preparation
@@ -37,22 +36,16 @@ issue is welcome. :)
 If you have your own database setup, below steps enables running a seperated container
 that runs SQLFlow server and Jupyter Notebook, which connects to your own database.
 
-1. Follow steps in
-[example/datasets](https://github.com/sql-machine-learning/sqlflow/blob/develop/example/datasets)
-to import sample data.
+1. Follow steps in [example/datasets](https://github.com/sql-machine-learning/sqlflow/blob/develop/example/datasets) to import sample data.
 
-1. After data is popularized in MySQL, let's test the installation from running a query in Jupyter
-   Notebook. If you are using Docker for Linux, please change `host.docker.internal:3306` to
-   `localhost:3306`. If you are connecting to a remote database, please make sure to change
-   `host.docker.internal:3306` to the remote address.
+1. After data is popularized in MySQL, let's test the installation by running a query in Jupyter Notebook. If you are using Docker for Linux, please change `host.docker.internal:3306` to `localhost:3306`. If you are connecting to a remote database, please make sure to change `host.docker.internal:3306` to the remote address.
 
    ```
    docker run -it -p 8888:8888 sqlflow/sqlflow:latest \
    bash -c "sqlflowserver --datasource='mysql://root:root@tcp(host.docker.internal:3306)/?maxAllowedPacket=0' &
    SQLFLOW_SERVER=localhost:50051 jupyter notebook --ip=0.0.0.0 --port=8888 --allow-root"
    ```
 
-   If you are using Docker for Mac, please be aware the option `--database` where `host.docker.internal` translates to the host IP address as recommended [here](https://docs.docker.com/docker-for-mac/networking/).
+If you are using Docker for Mac, please be aware the option `--database` where `host.docker.internal` translates to the host IP address as recommended [here](https://docs.docker.com/docker-for-mac/networking/).
 
-   If you are running MySQL on remote, please be aware that MySQL only allows connections from localhost
-   by default. Fix can be found [here](https://stackoverflow.com/questions/14779104/how-to-allow-remote-connection-to-mysql).
+If you are running MySQL on remote, please be aware that MySQL only allows connections from localhost by default. Fix can be found [here](https://stackoverflow.com/questions/14779104/how-to-allow-remote-connection-to-mysql).

doc/installation.md

@@ -4,13 +4,13 @@
 need it because github.com/sql-machine-larning/sqlflow is too long a
 Go import name.  We want it to be sqlflow.org/sqlflow.
 
-Our solution is to build a Web site https://sqlflow.org, whose page
+Our solution is to build a Website https://sqlflow.org, whose page
 http://sqlflow.org/sqlflow/index.html contains some meta information
 readable by the Go toolchain, so that the `go get` command knows that
 `import sqlflow.org/sqlflow` actually redirects to `import
 github.com/sql-machine-larning/sqlflow `.
 
-We build the Web site by the following steps.
+We build the Website by the following steps.
 
 1. We configure https://sqlflow.org pointing to
 http://sql-machine-learning.github.io, which is a Github Page Web site
@@ -25,7 +25,9 @@
 3. We put the meta information in this file as follows.
 
 Similarly, please don't remove any index.html in this repo that were
-marked generated by https://github.com/bramp/goredirects. -->
+marked generated by https://github.com/bramp/goredirects. 
+-->
+
 <html>
 <head>
 <meta name="go-import" content="sqlflow.org/sqlflow git https://github.com/sql-machine-learning/sqlflow">
@@ -38,4 +40,4 @@
 <body>
 	<h1>Redirecting to <a href="https://github.com/sql-machine-learning/sqlflow">https://github.com/sql-machine-learning/sqlflow</a></h1>
 </body>
-</html>
+</html>