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

bug-bash: Change phase to directive in custom logic doc #8001

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

Conversation

Guaris
Copy link
Contributor

@Guaris Guaris commented Oct 2, 2024

Fixes #7533

@Guaris Guaris added the review:general Review for general accuracy and presentation. Does the doc work? Does it output correctly? label Oct 2, 2024
@Guaris Guaris requested a review from a team as a code owner October 2, 2024 19:14
Copy link

netlify bot commented Oct 2, 2024

Deploy Preview for kongdocs ready!

Name Link
🔨 Latest commit 47e87d7
🔍 Latest deploy log https://app.netlify.com/sites/kongdocs/deploys/66fd9b7b8dd51b00081b498c
😎 Deploy Preview https://deploy-preview-8001--kongdocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
9 paths audited
Performance: 92 (no change from production)
Accessibility: 92 (no change from production)
Best Practices: 98 (🟢 up 8 from production)
SEO: 91 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

@@ -42,7 +42,7 @@ of {{site.base_gateway}}'s execution life-cycle:
- **[HTTP Module]** *is used for plugins written for HTTP/HTTPS requests*
{% if_version lte: 3.3.x %}

| Function name | Phase | Request Protocol | Description
| Function name | Directive | Request Protocol | Description
Copy link
Contributor

Choose a reason for hiding this comment

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

I think it's a bit more complicated than this. The items in this column cover both a phase and a directive. Check out the diagram here: https://github.com/openresty/lua-nginx-module?tab=readme-ov-file#directives.

As the reporter points out in the GH issue,

It looks like what we're actually missing is another column, which details what the directive is. So for rewrite, you get:

Function: rewrite
Phase: rewrite tail
Directives: rewrite_by_lua_*

Copy link
Contributor

@lena-larionova lena-larionova left a comment

Choose a reason for hiding this comment

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

This is missing the second part of the issue as well, which is:

An other issue concerns the "reponse" function, for which the phase is "access". However, according to the description, it replaces "header_filter()" and "body_filter()". As shown in the diagram in the Directives section, they are part of "Content Phase", not "Access Phase". This seems to be a mistake.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
review:general Review for general accuracy and presentation. Does the doc work? Does it output correctly?
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Confusing terms and concepts: "directives" and "phases"
2 participants