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: mention env var support in apisix.yaml #10727

Merged
merged 1 commit into from
Dec 28, 2023

Conversation

kayx23
Copy link
Member

@kayx23 kayx23 commented Dec 27, 2023

Description

Mention env var support in apisix.yaml and add a caution note for exporting vars.

See the below issues for more background info:

Closes #10509
Closes #10530

The info is also mentioned in the Admin API doc but not easy to locate. Personally I only found out after looking for the PR that adds the feature.

From a user perspective, when I search for apisix config env var, this is the doc that comes up first.

image

Though it seems from the doc title that this doc wasn't originally for this content.

There has been other user that recently mentioned the info could not be located:

image

https://the-asf.slack.com/archives/CUC5MN17A/p1703518877003939

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)

@AlinsRan AlinsRan merged commit d7cf12d into apache:master Dec 28, 2023
10 checks passed
@kayx23 kayx23 deleted the apisixyaml-env-var branch December 28, 2023 03:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants