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(kong.conf): add section for wasm nginx.conf directives #11387

Merged
merged 1 commit into from
Aug 24, 2023

Conversation

flrgh
Copy link
Contributor

@flrgh flrgh commented Aug 10, 2023

It's pretty wordy because there's a lot to explain. I'm also not sure what it will look like when rendered for docs.konghq.com, so if anyone has pointers on how to preview the end result, let me know.

@flrgh flrgh marked this pull request as ready for review August 10, 2023 23:10
@flrgh
Copy link
Contributor Author

flrgh commented Aug 10, 2023

Not sure if this needs a backport to release/3.4.x 🤔. @Guaris, can you tell me if we specifically/exclusively build auto-generated docs from release branches in Kong/kong? In other words, do I need to backport this to release/3.4.x in order for it to one day show up in https://docs.konghq.com/gateway/3.4.x/?

@hishamhm
Copy link
Contributor

I'm also not sure what it will look like when rendered for docs.konghq.com, so if anyone has pointers on how to preview the end result, let me know.

This commit 550ef15 says that the autodocs scripts that used to generate Markdown from this were replaced by a script in Enterprise which builds both EE and OSS docs, so there should be a script somewhere that allows building a previewable Markdown... 🤔

@pull-request-size pull-request-size bot added size/L and removed size/M labels Aug 10, 2023
Copy link
Contributor

@hishamhm hishamhm left a comment

Choose a reason for hiding this comment

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

Just gave it a quick skim, but will get back to it more carefully tomorrow!

kong.conf.default Show resolved Hide resolved
kong.conf.default Outdated Show resolved Hide resolved
kong.conf.default Outdated Show resolved Hide resolved
kong.conf.default Outdated Show resolved Hide resolved
kong.conf.default Show resolved Hide resolved
kong.conf.default Outdated Show resolved Hide resolved
kong.conf.default Show resolved Hide resolved
kong.conf.default Outdated Show resolved Hide resolved
kong.conf.default Outdated Show resolved Hide resolved
kong.conf.default Show resolved Hide resolved
kong.conf.default Outdated Show resolved Hide resolved
kong.conf.default Outdated Show resolved Hide resolved
kong.conf.default Outdated Show resolved Hide resolved
@flrgh
Copy link
Contributor Author

flrgh commented Aug 15, 2023

Labeling this one for backport for consistency's sake. It's a doc-only change, so it's harmless and doesn't necessitate a new release. If that's not desired, feel free to remove the label.

@Guaris
Copy link
Contributor

Guaris commented Aug 15, 2023

Thanks.

. @Guaris, can you tell me if we specifically/exclusively build auto-generated docs from release branches in Kong/kong

You don't need to backport this as far as I know. The process runs on the checkedout branch when you run the script.

kong.conf.default Outdated Show resolved Hide resolved
kong.conf.default Outdated Show resolved Hide resolved
kong.conf.default Show resolved Hide resolved
kong.conf.default Outdated Show resolved Hide resolved
kong.conf.default Show resolved Hide resolved
@flrgh flrgh force-pushed the docs/kong-conf-wasm-directives branch from 41a6fec to 8118658 Compare August 17, 2023 18:08
@flrgh flrgh force-pushed the docs/kong-conf-wasm-directives branch from 8118658 to 596db9a Compare August 17, 2023 18:08
@flrgh
Copy link
Contributor Author

flrgh commented Aug 21, 2023

@locao could I get a +1 on this?

@locao locao merged commit ef313ba into master Aug 24, 2023
21 checks passed
@locao locao deleted the docs/kong-conf-wasm-directives branch August 24, 2023 13:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants