openresty / openresty/lua-nginx-module
Documentation: move all the *_by_lua documentation to *_by_lua_block
Nobody has claimed this yet.
- Dominant language
- C
- Stars
- 11.8k
- Forks
- 2.1k
- Avg merge
- 6h 1m
- Merged PRs (30d)
- 6
Description
Currently the documentation of the functions writte in *_by_lua, with warning:
NOTE Use of this directive is discouraged following the v0.9.17 release. Use the access_by_lua_block directive instead.
But in the *_by_lua_block functions that are really supposed to be used it's written
"Same as function".
It should be vise-versa, documentation should be on the currently recommended functions and it should be referenced from the deprecated functions.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the documentation for the *_by_lua and *_by_lua_block directives in the repository and compare their current wording. Move the detailed documentation to the recommended *_by_lua_block directives, leaving the deprecated directives to reference them, and verify that each relevant pair is covered.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua, nginx
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100