feat: add NGINX variable documentation #203
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
ryepup
commented
Jun 7, 2024
New function and new data file from running the converter.
ryepup
force-pushed
the
201-add-variables
branch
from
2fee1ee
to
4f0e978
Compare
danielledeleo
approved these changes
Jun 11, 2024
ryepup
added a commit
to ryepup/nginx-editor
that referenced
this pull request
Jun 11, 2024
The previous version of `@nginx/reference-lib` did not have NGINX variables (like `$binary_remote_addr`), update and include those in the autocomplete array. The old web scraper included these variables, but often had inaccurate descriptions. See also: nginx/nginx-directive-reference#203
jaywcjlove
pushed a commit
to jaywcjlove/nginx-editor
that referenced
this pull request
Jun 11, 2024
The previous version of `@nginx/reference-lib` did not have NGINX variables (like `$binary_remote_addr`), update and include those in the autocomplete array. The old web scraper included these variables, but often had inaccurate descriptions. See also: nginx/nginx-directive-reference#203
github-actions bot
pushed a commit
to jaywcjlove/nginx-editor
that referenced
this pull request
Jun 11, 2024
The previous version of `@nginx/reference-lib` did not have NGINX variables (like `$binary_remote_addr`), update and include those in the autocomplete array. The old web scraper included these variables, but often had inaccurate descriptions. See also: nginx/nginx-directive-reference#203 23a3800
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.
Proposed changes
Parse NGINX variables from the XML docs, and include them in the data files. This will enable hints on variables like
$binary_remote_addr, which are currently very broken in the web scraping solutions.Fixes #201
Checklist
Before creating a PR, run through this checklist and mark each as complete.
CONTRIBUTINGdocumentREADME.mdandCHANGELOG.md)