Add markdownlint and fix partial md files (#982)

Signed-off-by: kwanhur <huang_hua2012@163.com>

.markdownlint.yml

@@ -0,0 +1,32 @@
+# Copyright 2022 The BFE Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# rules from https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md
+MD001: false
+MD004: false
+MD005: false
+MD006: false
+MD007: false
+MD010: false
+MD013: false
+MD014: false
+MD024: false
+MD026: false
+MD029: false
+MD033: false
+MD034: false
+MD036: false
+MD040: false
+MD041: false
+MD046: false

CHANGELOG.md

@@ -13,26 +13,32 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [v1.5.0] - 2022-01-11
 
 ### Added
+
 - Add mod_tcp_keepalive to support custom TCP KeepAlive configuration
 - Documents optimization
 
 ### Changed
+
 - Change JSON parser: use json-iterator to replace encoding/json
 - Optimize error handling in io.Write
 
 ### Fixed
+
 - Fix issue in go.mod which may cause build error (Issue #933)
 
 ### Security
+
 - Fix http security issue (Issue #940)
 - Fix http security issue (Issue #941)
 
 ## [v1.4.0] - 2021-12-10
 
 ### Added
+
 - Documents optimization
 
 ### Changed
+
 - Upgrade golang version from 1.13 to 1.17
 - mod_markdown: upgrade bluemonday version to 1.0.16
 - Optimize mutex
@@ -41,30 +47,33 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [v1.3.0] - 2021-09-16
 
 ### Added
+
 - Support basic route rules that are similar to k8s ingress rules
 - Documents optimization
 
 ### Changed
-- Ignore GREASE values for JA3 fingerprint
 
+- Ignore GREASE values for JA3 fingerprint
 
 ## [v1.2.0] - 2021-06-21
 
 ### Added
-- Set GOMAXPROCS according to real CPU quota if running on container 
+
+- Set GOMAXPROCS according to real CPU quota if running on container
 - Support condition primitive bfe_time_range/bfe_periodic_time_range
 - Support URI hash strategy
 - mod_block: support global request rules and ALLOW action
 - mod_header: support variables about client certificate
 - mod_access: support log to single file and stdout
 
 ### Changed
-- Change primitive params of req_context_value_in
 
+- Change primitive params of req_context_value_in
 
 ## [v1.1.0] - 2021-04-08
 
 ### Added
+
 - Support JA3 fingerprint for SSL/TLS client
 - Support Slow‑Start to allow a backend instance gradually recover its weight
 - Add maxConnPerHost to limit the number of connections to a backend
@@ -75,44 +84,48 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Documents optimization
 
 ### Changed
+
 - Change outlierDetectionLevel to OutlierDetectionHttpCode
 
 ### Fixed
+
 - Fix panic when write internal response timeout
 - Fix unit test in bfe_spdy/frame_test.go under go 1.16
 
 ### Security
-- Fix config loading for multi-value option
 
+- Fix config loading for multi-value option
 
 ## [v1.0.0] - 2021-01-15
 
 ### Added
+
 - Add condition primitive: req_path_contain/req_path_element_prefix_in/req_context_value_in
 - Add outlier detection options
 - Add mod_waf with rule to detect exploitation of "Shellshock" GNU Bash RCE vulnerability.
 
 ### Fixed
+
 - Fix build issue under go1.15 environment
 - Fix processing X-Forwarded-For header value
 - Fix write timeout of internal response generated by bfe
 
-
 ## [v0.12.0] - 2020-09-03
 
 ### Added
+
 - Support gRPC over HTTP/2
 - Support communication with FastCGI server
 - Reduce objects number by release some objects that are not used as soon as possible
-- Replace ffjson with json-iterator 
+- Replace ffjson with json-iterator
 - net/textproto: turn an ancient DoS BUG annotation into a comment
 - Optimize processing of new connections under PROXY mode
 - Support integration testing in CI
 
-
 ## [v0.11.0] - 2020-07-24
 
 ### Added
+
 - Add mod_cors to enable cross-origin resource sharing
 - Add mod_secure_link to check authenticity and limit lifetime of links
 - Support PROXY protocol for TCP connections to backend
@@ -123,22 +136,27 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Add arm64 support for goreleaser
 
 ### Changed
+
 - Create listeners in the final initialization step
 - Change package name to 'github.com/bfenetworks/bfe'
 
 ### Removed
+
 - Drops words like blacklist from programming to make vocabulary more inclusive
 - Remove legacy signature of response
 
 ### Fixed
+
 - Fix getTransport() and modify transports map with write lock
 
 ### Security
-- Fix textproto: not normalize headers with spaces before the colon (CVE-2019-16276)
 
+- Fix textproto: not normalize headers with spaces before the colon (CVE-2019-16276)
 
 ## [v0.10.0] - 2020-05-25  
+
 ### Added
+
 - mod_auth_request: authorize clients based on thirdparty authorization service
 - mod_trace: support tracing based on Elastic APM
 - mod_compress: support brotli algorithm
@@ -148,14 +166,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Documents optimization
 
 ### Changed
+
 - Refactor and simplify mod_auth_jwt
 
 ### Removed
-- Remove legacy type of Layer4LoadBalancer 
 
+- Remove legacy type of Layer4LoadBalancer
 
 ## [v0.9.0] - 2020-04-16
+
 ### Added
+
 - Support loading dynamic modules that may be written and complied by thirdparty vendors
 - Add mod_auth_jwt for JWT authentication
 - mod_trace: support distributed tracing based on jaeger
@@ -166,42 +187,49 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Documents optimization
 
 ### Changed
+
 - Change base directory of ServerCertFile/ServerKeyFile to ConfRoot
 
 ### Fixed
-- Fix failed unit tests about parsing request line under go1.14 environment
 
+- Fix failed unit tests about parsing request line under go1.14 environment
 
 ## [v0.8.0] - 2020-03-27
+
 ### Added
+
 - Add mod_trace for distributed tracing based on zipkin
 - Add mod_doh for processing DNS over HTTPS(DoH) requests
 - Support TLS protocol with SM related ciphersuites
 - mod_header: add cookie related actions
 - Documents optimization
 
 ### Changed
-- Disable sanitization of cookie value
 
+- Disable sanitization of cookie value
 
 ## [v0.7.0] - 2020-02-26
+
 ### Added
+
 - mod_access support NCSA Common Log Format(CLF) and W3C Extended Log Format(ELF)
 - mod_static suuport HTTP HEAD method
 - Add mod_userid for client identification
 - Add mod_tag for tagging and tracking groups of requests
 - http cookie: support Expires attribute in GMT format
-- http cookie: support SameSite attribute 
+- http cookie: support SameSite attribute
 - Add static check in Makefile
 - Compiling on Windows OS is supported
 - Documents optimization
 
 ### Fixed
-- Fix a bug that causes invalid ips are parsed and treated as domain names
 
+- Fix a bug that causes invalid ips are parsed and treated as domain names
 
 ## [v0.6.0] - 2020-01-21
+
 ### Added
+
 - Add mod_prison to limit the amount of requests a user can make in a given period of time.
 - Add condition primitive: ses_tls_sni_in/ses_tls_client_auth/ses_tls_client_ca_in
 - Add tls mutual authentication
@@ -217,12 +245,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Documents optimization
 
 ### Changed
+
 - Change default Layer4LoadBalancer to NONE
 - Upgrade from go1.12 to go1.13
 
-
 ## [v0.5.0] - 2019-12-12
+
 ### Added
+
 - Add mod_geo to determine user geolocation by MaxMind database
 - Add mod_auth_basic to restrict access from unknown users
 - Add mod_compress to compress response by customize rules
@@ -235,41 +265,47 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Documents optimization
 
 ### Changed
+
 - Change default monitor port to 8421
 - Rename HANDLE_READ_BACKEND to HANDLE_READ_RESPONSE
 
 ### Removed
-- Remove some legacy fields from mod_access
 
+- Remove some legacy fields from mod_access
 
 ## [v0.4.0] - 2019-11-19
+
 ### Added
+
 - Expose metrics in prometheus text-based format
 - Add default value for core configs to reduce configuration cost
 - Add mod_static to serve static content by customize rules
 - Documents optimization
 
 ### Changed
+
 - mod_logid: random logid in hex encoding format
 
 ### Removed
-- Remove signal SIGSTKFLT
 
+- Remove signal SIGSTKFLT
 
 ## [v0.3.0] - 2019-10-17
 
 ### Added
+
 - Add condition primitive: req_cip_hash_in/req_header_value_hash_in/req_cookie_value_hash_in/req_query_value_hash_in
 - Add mod_header variable: bfe_log_id
 - Add mod_http_code to maintain basic status about response forwarded
 
 ### Security
-- Fix http2: limit number of control frames in server send queue (CVE-2019-9512, CVE-2019-9514)
 
+- Fix http2: limit number of control frames in server send queue (CVE-2019-9512, CVE-2019-9514)
 
 ## [v0.2.0] - 2019-09-26
 
 ### Added
+
 - Add proxy protocol to be compatible with F5 BigIP/Citrix ADC etc
 - Add mod_access to write request/session log in customized format
 - Add mod_key_log to wirte tls key log so that external programs(eg. wireshark) can decrypt TLS connections for trouble shooting
@@ -278,19 +314,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Documents optimization
 
 ### Changed
-- reverseproxy: flush response header immediately if flushInterval<0
 
+- reverseproxy: flush response header immediately if flushInterval<0
 
 ## [v0.1.0] - 2019-08-01
 
 ### Added
+
 - Multiple protocols supported, including HTTP, HTTPS, SPDY, HTTP2, WebSocket, TLS, etc
 - Content based routing, support user-defined routing rule in advanced domain-specific language
 - Support multiple load balancing policies
 - Flexible plugin framework to extend functionality. Based on the framework, developer can add new features rapidly
 - Detailed built-in metrics available for service status monitor
 
-
 [v1.5.0]: https://github.com/bfenetworks/bfe/compare/v1.4.0...v1.5.0
 [v1.4.0]: https://github.com/bfenetworks/bfe/compare/v1.3.0...v1.4.0
 [v1.3.0]: https://github.com/bfenetworks/bfe/compare/v1.2.0...v1.3.0