new doc #1086
new doc #1086
Conversation
README.md
Outdated
| - [WebSocket](docs/02.Tutorials/2.6.Websocket.md) - WebSocket proxy for Easegress | ||
| - [Workflow](docs/03.Advanced-Cookbook/3.10.Workflow.md) - An Example to make a workflow for a number of APIs. | ||
|
|
||
| For full list, see [Tutorials](docs/02.Tutorials/README.md) and [Cookbook](docs/03.Advanced-Cookbook/README.md). | ||
|
|
||
| ## Getting Started |
There was a problem hiding this comment.
I think it's better to add minimal scripts containing starting server and creating HTTP proxy by using egctl create httpproxy ....
There was a problem hiding this comment.
Updated, please check.
|
|
||
| The easiest way to install Easegress is by using pre-built binaries: | ||
|
|
||
| 1. Download the appropriate compressed archive file for your platform from [Releases](https://github.com/megaease/easegress/releases). |
There was a problem hiding this comment.
It's better to give 3 lines of scripts to demo to help users copy-change-paste. Most readers just want to copy-paste.
There was a problem hiding this comment.
This is download release from github by using web browsers like Chrome or Edge. Then double click it to uncompressed the file. So... Write scripts is a little bit complicated depend on different os and different browsers. I do add examples in the following ways.
|
|
||
| The reverse proxy is the common middleware that is accessed by clients, forwards them to backend servers. The reverse proxy is a very core role played by Easegress. | ||
|
|
||
| The filter `Proxy` is the filter to fire requests to backend servers. It contains servers group under load balance, whose policy support `roundRobin`, `random`, `weightedRandom`, `ipHash`, `headerHash`. |
There was a problem hiding this comment.
It is better to refer to the balance reference to check all specs of all policies.
docs/07.Reference/7.05.Stream.md
Outdated
| @@ -16,10 +16,10 @@ whether a request/response is a stream, for example: | |||
|
|
|||
| * We can set `clientMaxBodySize` of an HTTP server to a negative value to | |||
| tell Easegress the request is a stream, and not a stream otherwise. Please | |||
| refer [HTTP Server](./controllers.md#httpserver) for more information. | |||
| refer [HTTP Server](7.01.Controllers.md#httpserver) for more information. | |||
There was a problem hiding this comment.
Should this file lay in the developer guide part instead of reference?
There was a problem hiding this comment.
The Stream.md is mainly used to explain clientMaxBodySize argument in HTTPServer and serverMaxBodySize argument in Proxy. It is referenced by HTTPServer and Proxy filter too.
There was a problem hiding this comment.
It is an amazing job, however, I have some questions
- what's the difference between
docdirectory anddocsdirectory? why do we remain thedoc? - The URL of some pictures might be outdated. Please check it and make sure it is right, especially the essential files like
README.md.
| @@ -13,22 +13,14 @@ | |||
| alt="Easegress logo" title="Easegress" height="175" width="175" align="right"/> | |||
There was a problem hiding this comment.
<img src="./doc/imgs/easegress.svg" should be ./docs/imgs/easegress.svg.
There would be other similar problems, please check it.
| Version: 1.0.0 | ||
| Hostname: hello-deployment-6cbf765985-r6242 | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Please add the description to the document.
- NOTE:
You can get the NODE_IP and NODE_PORT by running the following command:
export NODE_PORT=$(kubectl get --namespace easegress -o jsonpath="{.spec.ports[0].nodePort}" services easegress)
export NODE_IP=$(kubectl get nodes --namespace easegress -o jsonpath="{.items[0].status.addresses[0].address}")
echo http://$NODE_IP:$NODE_PORT
For first question, there are two main reasons...
|
Co-authored-by: Loki's Wager <[email protected]>
Co-authored-by: Loki's Wager <[email protected]>
Co-authored-by: Loki's Wager <[email protected]>
Co-authored-by: Loki's Wager <[email protected]>
No description provided.