docs: updated Stream Proxy doc #9367
Conversation
|
@navendu-pottekkat @Neilblaze @moonming can any mod help with approval? Small change. Easy to review. Thanks! |
|
@kayx23 Could you check the failing lint check? Ready to merge after that. |
|
@navendu-pottekkat sigh, my favourite thing to do, adding trailing spaces and failing CI checks! Should be good now. btw, I've noticed quite a few times that people are merging doc improvements PR into version specific branches which aren't carried over to the main branch. This was resulted from directly using the "edit this page" button on the front end which automatically propose PR changes into a specific version (though you can select which branch to merge into but people dont usually notice). For my first doc PR I had to open a new PR to merge into the master branch. I subsequently discovered if you JUST merge the doc change into the master branch, the change isn't reflected in the most current version of doc (say 3.2). This might result in people thinking the latest doc is still outdated and waste time fixing docs that are already fixed? Had a quick discussion w @Neilblaze not long while ago. Wonder what the suggested practice/workflow is here? |
|
@kayx23 I guess it could be the delay between running updates to the apisix-website repo and updating this repo. Changes made here are only updated on the site when the apisix-website repo is built and published. The most recent changes are shown in the "next" version and not on the latest available version. When a new version of APISIX is released, the docs for it are also updated. Does merging to version specific branches update the doc for that specific version? If yes, that might be the desired way it should work. |
It does, but some of these changes are meant to be effective for subsequent releases and therefore, better be in master branch. I have left comments under all doc PRs merged into release 3.2 last time I noticed that look like they should be in master branch. Nobody seems to reply so far.
ok understood |
|
work in progress |
kayx23
changed the title
|
changing this much for now. ready for review |
* upstream/master: (42 commits) fix: add `rust-check` target to the makefile for deps pre-checking (apache#9453) test: remove duplicate `proto` unit test file and tweak test case title (apache#9445) feat: proxy-mirror add grpc and grpcs support (apache#9388) test: replace all httpbin upstream (apache#9452) fix: 404 error in ci test (apache#9447) fix: body-transformer plugin return raw body anytime (apache#9446) fix(ci): fips: ensure apisix compiles with openssl3 (apache#9427) chore(deps): bump actions/stale from 7 to 8 (apache#9159) chore(deps): bump actions/setup-node from 3.5.1 to 3.6.0 (apache#8625) chore(test): split the access log of apisix and test server (apache#8819) docs: fix grammar (apache#9395) fix(wolf-rbac): other plugin in consumer not effective when consumer used wolf-rbac plugin (apache#9287) (apache#9298) docs: use shell instead of Python to configure protos resources (apache#9414) docs: add guide to authenticate websocket connections (apache#9369) docs: updated Stream Proxy doc (apache#9367) feat: proxy_rewrite support miltiple regex pattern matching (apache#9194) feat: route-level MTLS (apache#9322) ci: tcp logger with real logger server (apache#9392) fix: always parse domain when host is domain name (apache#9332) docs: CHANGELOG.md Chinese docs lint (apache#9411) ...
Description
Improved the part of doc before the MySQL example in Stream Proxy doc
Checklist