You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2022/03/14 16:54:17 UTC
[GitHub] [apisix] avinal opened a new pull request #6610: docs: Move keyword definition to `Terminology` section and improve
avinal opened a new pull request #6610:
URL: https://github.com/apache/apisix/pull/6610
### What this PR does / why we need it:
<!--- Why is this change required? What problem does it solve? -->
<!--- If it fixes an open issue, please link to the issue here. -->
This pull request restructures the architecture category and creates a new category for the general keywords/terms used in context of Apache APISIX. More terms and their definations can be added later.
- Adds terminology chapter
- Adds definition for API-Gateway
- Fixes #6549
### Pre-submission checklist:
<!--
Please follow the PR manners:
1. Use Draft if the PR is not ready to be reviewed
2. Test is required for the feat/fix PR, unless you have a good reason
3. Doc is required for the feat PR
4. Use a new commit to resolve review instead of `push -f`
5. If you need to resolve merge conflicts after the PR is reviewed, please merge master but do not rebase
6. Use "request review" to notify the reviewer once you have resolved the review
7. Only reviewer can click "Resolve conversation" to mark the reviewer's review resolved
-->
* [x] Did you explain what problem does this PR solve? Or what new features have been added?
* [x] Have you added corresponding test cases?
* [x] Have you modified the corresponding document?
* [x] Is this PR backward compatible? **If it is not backward compatible, please discuss on the [mailing list](https://github.com/apache/apisix/tree/master#community) first**
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] membphis commented on a change in pull request #6610: docs: move keyword definition to `Terminology` section and improve
Posted by GitBox <gi...@apache.org>.
membphis commented on a change in pull request #6610:
URL: https://github.com/apache/apisix/pull/6610#discussion_r828913160
##########
File path: docs/en/latest/config.json
##########
@@ -6,18 +6,25 @@
"label": "Architecture Design",
"items": [
"architecture-design/apisix",
- "architecture-design/route",
- "architecture-design/plugin",
- "architecture-design/script",
- "architecture-design/service",
- "architecture-design/consumer",
- "architecture-design/upstream",
- "architecture-design/global-rule",
"architecture-design/plugin-config",
- "architecture-design/router",
"architecture-design/debug-mode"
]
},
+ {
+ "type": "category",
+ "label": "Terminology",
+ "items": [
+ "terminology/api-gateway",
Review comment:
this order is fine for me:
API Gateway
Route
Service
Upstream
Consumer
xxx
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] juzhiyuan commented on a change in pull request #6610: docs: move keyword definition to `Terminology` section and improve
Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on a change in pull request #6610:
URL: https://github.com/apache/apisix/pull/6610#discussion_r826693242
##########
File path: docs/en/latest/config.json
##########
@@ -6,18 +6,25 @@
"label": "Architecture Design",
"items": [
"architecture-design/apisix",
- "architecture-design/route",
- "architecture-design/plugin",
- "architecture-design/script",
- "architecture-design/service",
- "architecture-design/consumer",
- "architecture-design/upstream",
- "architecture-design/global-rule",
"architecture-design/plugin-config",
- "architecture-design/router",
"architecture-design/debug-mode"
]
},
+ {
+ "type": "category",
+ "label": "Terminology",
+ "items": [
+ "terminology/api-gateway",
Review comment:
How about this way:
1. API Gateway
2. Consumer
3. Upstream
4. Route
5. Service
6. xxx
People may know something first, then something else 😉
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] avinal commented on a change in pull request #6610: docs: move keyword definition to `Terminology` section and improve
Posted by GitBox <gi...@apache.org>.
avinal commented on a change in pull request #6610:
URL: https://github.com/apache/apisix/pull/6610#discussion_r826680583
##########
File path: docs/en/latest/architecture-design/debug-mode.md
##########
@@ -63,10 +63,10 @@ The checker would only check this if the file was updated by checking its last m
| Key | Optional | Description | Default |
| ------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------- |
| hook_conf.enable | required | Enable/Disable hook debug trace. Target module function's input arguments or returned value would be printed once this option is enabled. | false |
-| hook_conf.name | required | The module list name of the hook which has enabled debug trace. | |
-| hook_conf.log_level | required | Logging levels for input arguments & returned values. | warn |
-| hook_conf.is_print_input_args | required | Enable/Disable printing input arguments. | true |
-| hook_conf.is_print_return_value | required | Enable/Disable printing returned values. | true |
+| hook_conf.name | required | The module list name of the hook which has enabled debug trace. | |
+| hook_conf.log_level | required | Logging levels for input arguments & returned values. | warn |
+| hook_conf.is_print_input_args | required | Enable/Disable printing input arguments. | true |
+| hook_conf.is_print_return_value | required | Enable/Disable printing returned values. | true |
Review comment:
I think this is just reformatted, removed tabs and instead used spaces, a precaution for indentation-sensitive languages. Tabs and spaces are often mixed and can cause issues, so it is preferred to use spaces everywhere until otherwise needed.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] spacewander merged pull request #6610: docs: move keyword definition to `Terminology` section and improve
Posted by GitBox <gi...@apache.org>.
spacewander merged pull request #6610:
URL: https://github.com/apache/apisix/pull/6610
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] avinal commented on a change in pull request #6610: docs: move keyword definition to `Terminology` section and improve
Posted by GitBox <gi...@apache.org>.
avinal commented on a change in pull request #6610:
URL: https://github.com/apache/apisix/pull/6610#discussion_r828935061
##########
File path: docs/en/latest/config.json
##########
@@ -6,18 +6,25 @@
"label": "Architecture Design",
"items": [
"architecture-design/apisix",
- "architecture-design/route",
- "architecture-design/plugin",
- "architecture-design/script",
- "architecture-design/service",
- "architecture-design/consumer",
- "architecture-design/upstream",
- "architecture-design/global-rule",
"architecture-design/plugin-config",
- "architecture-design/router",
"architecture-design/debug-mode"
]
},
+ {
+ "type": "category",
+ "label": "Terminology",
+ "items": [
+ "terminology/api-gateway",
Review comment:
Okay, I will change it.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] spacewander merged pull request #6610: docs: move keyword definition to `Terminology` section and improve
Posted by GitBox <gi...@apache.org>.
spacewander merged pull request #6610:
URL: https://github.com/apache/apisix/pull/6610
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] avinal commented on pull request #6610: docs: Move keyword definition to `Terminology` section and improve
Posted by GitBox <gi...@apache.org>.
avinal commented on pull request #6610:
URL: https://github.com/apache/apisix/pull/6610#issuecomment-1067059835
I think more content can be added to API-Gateway doc but not sure what, please suggest. And we can reference this doc wherever needed.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] avinal commented on pull request #6610: docs: move keyword definition to `Terminology` section and improve
Posted by GitBox <gi...@apache.org>.
avinal commented on pull request #6610:
URL: https://github.com/apache/apisix/pull/6610#issuecomment-1067697919
> LGTM except the sidebar smile
Things will get messy at first before everything comes to a beautiful order. 😄
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] avinal commented on a change in pull request #6610: docs: move keyword definition to `Terminology` section and improve
Posted by GitBox <gi...@apache.org>.
avinal commented on a change in pull request #6610:
URL: https://github.com/apache/apisix/pull/6610#discussion_r826681753
##########
File path: docs/en/latest/config.json
##########
@@ -6,18 +6,25 @@
"label": "Architecture Design",
"items": [
"architecture-design/apisix",
- "architecture-design/route",
- "architecture-design/plugin",
- "architecture-design/script",
- "architecture-design/service",
- "architecture-design/consumer",
- "architecture-design/upstream",
- "architecture-design/global-rule",
"architecture-design/plugin-config",
- "architecture-design/router",
"architecture-design/debug-mode"
]
},
+ {
+ "type": "category",
+ "label": "Terminology",
+ "items": [
+ "terminology/api-gateway",
Review comment:
I have put them in alphabetical order, as we do with dictionaries since terminologies are similar to dictionaries. Please let me know if anything else is more accurate.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] avinal commented on pull request #6610: docs: move keyword definition to `Terminology` section and improve
Posted by GitBox <gi...@apache.org>.
avinal commented on pull request #6610:
URL: https://github.com/apache/apisix/pull/6610#issuecomment-1067686412
> One question: do we need to use Docusaurus's markup in this PR? I mean `:::note` instead of `## NOTE`.
>
> I personally would prefer using Docusaurus's advanced features in another PR, to format all markdown files in once.
That will work too, and my suggestion is to use advanced docusauraus markup since they can make the documentation rich and help navigate and highlight important parts. For now, I will remove them from this PR 👍🏼
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] zaunist commented on a change in pull request #6610: docs: Move keyword definition to `Terminology` section and improve
Posted by GitBox <gi...@apache.org>.
zaunist commented on a change in pull request #6610:
URL: https://github.com/apache/apisix/pull/6610#discussion_r826606355
##########
File path: docs/en/latest/config.json
##########
@@ -295,4 +302,4 @@
"href": "https://github.com/apache/apisix/blob/master/CHANGELOG.md"
}
]
-}
+}
Review comment:
```suggestion
}
```
Need a blank line at the end of file.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] avinal commented on pull request #6610: docs: move keyword definition to `Terminology` section and improve
Posted by GitBox <gi...@apache.org>.
avinal commented on pull request #6610:
URL: https://github.com/apache/apisix/pull/6610#issuecomment-1067687793
Also, I just noticed they are already in use in many of the docs, so can I keep it?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] juzhiyuan commented on a change in pull request #6610: docs: move keyword definition to `Terminology` section and improve
Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on a change in pull request #6610:
URL: https://github.com/apache/apisix/pull/6610#discussion_r826674718
##########
File path: docs/en/latest/terminology/route.md
##########
@@ -21,11 +21,13 @@ title: Route
#
-->
-Routes match the client's request based on defined rules, loads and executes the corresponding [plugins](./plugin.md), and forwards the request to the specified [Upstream](./upstream.md).
+## Description
+
+Routes match the client's request based on defined rules, load and execute the corresponding [plugins](./plugin.md), and forwards the request to the specified [Upstream](./upstream.md).
A Route mainly consists of three parts:
-1. Matching rules (uri, host, remote address)
+1. Matching rules (`uri`, `host`, `remote address)
Review comment:
```suggestion
1. Matching rules (`uri`, `host`, `remote address`)
```
##########
File path: docs/en/latest/architecture-design/debug-mode.md
##########
@@ -63,10 +63,10 @@ The checker would only check this if the file was updated by checking its last m
| Key | Optional | Description | Default |
| ------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------- |
| hook_conf.enable | required | Enable/Disable hook debug trace. Target module function's input arguments or returned value would be printed once this option is enabled. | false |
-| hook_conf.name | required | The module list name of the hook which has enabled debug trace. | |
-| hook_conf.log_level | required | Logging levels for input arguments & returned values. | warn |
-| hook_conf.is_print_input_args | required | Enable/Disable printing input arguments. | true |
-| hook_conf.is_print_return_value | required | Enable/Disable printing returned values. | true |
+| hook_conf.name | required | The module list name of the hook which has enabled debug trace. | |
+| hook_conf.log_level | required | Logging levels for input arguments & returned values. | warn |
+| hook_conf.is_print_input_args | required | Enable/Disable printing input arguments. | true |
+| hook_conf.is_print_return_value | required | Enable/Disable printing returned values. | true |
Review comment:
I don't see changes in this section, not sure why GitHub highlighted this part.
##########
File path: docs/en/latest/config.json
##########
@@ -6,18 +6,25 @@
"label": "Architecture Design",
"items": [
"architecture-design/apisix",
- "architecture-design/route",
- "architecture-design/plugin",
- "architecture-design/script",
- "architecture-design/service",
- "architecture-design/consumer",
- "architecture-design/upstream",
- "architecture-design/global-rule",
"architecture-design/plugin-config",
- "architecture-design/router",
"architecture-design/debug-mode"
]
},
+ {
+ "type": "category",
+ "label": "Terminology",
+ "items": [
+ "terminology/api-gateway",
Review comment:
cc @membphis, if we need to adjust those items' order?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] juzhiyuan commented on a change in pull request #6610: docs: move keyword definition to `Terminology` section and improve
Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on a change in pull request #6610:
URL: https://github.com/apache/apisix/pull/6610#discussion_r826693242
##########
File path: docs/en/latest/config.json
##########
@@ -6,18 +6,25 @@
"label": "Architecture Design",
"items": [
"architecture-design/apisix",
- "architecture-design/route",
- "architecture-design/plugin",
- "architecture-design/script",
- "architecture-design/service",
- "architecture-design/consumer",
- "architecture-design/upstream",
- "architecture-design/global-rule",
"architecture-design/plugin-config",
- "architecture-design/router",
"architecture-design/debug-mode"
]
},
+ {
+ "type": "category",
+ "label": "Terminology",
+ "items": [
+ "terminology/api-gateway",
Review comment:
How about this way:
1. API Gateway
2. Consumer
3. Upstream
4. Route
5. Service
6. xxx
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] juzhiyuan commented on pull request #6610: docs: move keyword definition to `Terminology` section and improve
Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on pull request #6610:
URL: https://github.com/apache/apisix/pull/6610#issuecomment-1067692577
> Also, I just noticed they are already in use in many of the docs, so can I keep it?
OK 😉
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org