Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Correcting grammatical errors in the installation guide document. #11783

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

MrLinMH
Copy link
Contributor

@MrLinMH MrLinMH commented Nov 27, 2024

Description

There is a grammatical error in the provided config.yaml configuration in the "Updating Admin API key" section of the APISIX installation guide, missing a colon.

Fixes # (issue)

Checklist

  • I have explained the need for this PR and the problem it solves
  • I have explained the changes or the new features added to this PR
  • I have added tests corresponding to this change
  • I have updated the documentation to reflect this change
  • I have verified that this change is backward compatible (If not, please discuss on the APISIX mailing list first)

@dosubot dosubot bot added size:S This PR changes 10-29 lines, ignoring generated files. doc Documentation things labels Nov 27, 2024
@MrLinMH MrLinMH changed the title doc: Correcting grammatical errors in the installation guide document. docs: Correcting grammatical errors in the installation guide document. Nov 27, 2024
Copy link
Member

@kayx23 kayx23 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤔 if I'm not mistaken I think the original grammar works as well. I've seen it elsewhere,

e.g. in the FAQ doc:

image

and decoupled mode:

image

I remember having the same question as well (long time ago) and tested this configuration format; it did work.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation things size:S This PR changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants