docs: fix typo and added useful information #8900
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Also fixed the failing test in this commit
shreemaan-abhishek
approved these changes
Mar 6, 2023
tokers
approved these changes
Mar 7, 2023
moonming
approved these changes
Jun 29, 2023
hongbinhsu
added a commit
to fitphp/apix
that referenced
this pull request
Jul 8, 2023
* upstream/master: (70 commits) fix(workflow): enhance schema check (apache#9782) docs: add chinese documentation for loki-logger (apache#9687) chore(update): stand-alone text (apache#9736) docs: add Secret chinese document to Admin API (apache#9522) fix(log-rotate): can not keep max files when using custom name (apache#9749) docs: fix typo and added useful information (apache#8900) docs: explain in more details for the batch-requests plugin (apache#9629) docs: update `apisix` section in `config-default.yaml` (apache#9611) chore: add missing `report_interval` option for `skywalking` plugin in `config-default.yaml` (apache#9662) refactor(jwt-auth): remove unused parameter (apache#9716) change(request-id): remove snowflake algorithm (apache#9715) fix test case (apache#9706) docs: add correct link for openresty arm64 repo (apache#9713) fix: get the correct revision (apache#9635) fix(body-transformer): xml2lua: replace empty table with empty string (apache#9669) feat(prometheus): allow user configure DEFAULT_BUCKETS (apache#9673) docs: add example for timeout (apache#9708) docs: replace some urls that point to github with relative paths (apache#9684) docs: update Debian Installation Guide (apache#9680) docs: update how to install apisix on debian (apache#9693) ...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Talking about changes, I have removed typos, grammatical mistakes and added relevant details to make this documentation more informative and professional. The motivation behind this change is that any user who came to read the documentation should understand at once what this code is doing and what the documentation is saying. Before the changes, there was a lot of missing and misleading information, I restructure that information so that it can give more meaning. Explained some points in detail so that it can help the reader to grasp the concept at once.
Summary
Checklist