You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by "kayx23 (via GitHub)" <gi...@apache.org> on 2023/04/25 02:34:03 UTC

[GitHub] [apisix] kayx23 opened a new pull request, #9367: docs: updated description for Stream Proxy

kayx23 opened a new pull request, #9367:
URL: https://github.com/apache/apisix/pull/9367

   ### Description
   
   Previous description for stream proxy barely make any sense. Updated overview section for improved doc accuracy. 
   
   
   ### Checklist
   
   - [x] I have explained the need for this PR and the problem it solves
   - [x] I have explained the changes or the new features added to this PR
   - [ ] I have added tests corresponding to this change
   - [x] I have updated the documentation to reflect this change
   - [x] I have verified that this change is backward compatible (If not, please discuss on the [APISIX mailing list](https://github.com/apache/apisix/tree/master#community) first)
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [apisix] navendu-pottekkat commented on pull request #9367: docs: updated description for Stream Proxy

Posted by "navendu-pottekkat (via GitHub)" <gi...@apache.org>.
navendu-pottekkat commented on PR #9367:
URL: https://github.com/apache/apisix/pull/9367#issuecomment-1521101278

   @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.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [apisix] kayx23 commented on pull request #9367: docs: updated Stream Proxy doc

Posted by "kayx23 (via GitHub)" <gi...@apache.org>.
kayx23 commented on PR #9367:
URL: https://github.com/apache/apisix/pull/9367#issuecomment-1526504982

   ready for review


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [apisix] juzhiyuan merged pull request #9367: docs: updated Stream Proxy doc

Posted by "juzhiyuan (via GitHub)" <gi...@apache.org>.
juzhiyuan merged PR #9367:
URL: https://github.com/apache/apisix/pull/9367


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [apisix] kayx23 commented on pull request #9367: docs: updated description for Stream Proxy

Posted by "kayx23 (via GitHub)" <gi...@apache.org>.
kayx23 commented on PR #9367:
URL: https://github.com/apache/apisix/pull/9367#issuecomment-1522779277

   @navendu-pottekkat please help with merging the change. Thanks!


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [apisix] navendu-pottekkat commented on pull request #9367: docs: updated description for Stream Proxy

Posted by "navendu-pottekkat (via GitHub)" <gi...@apache.org>.
navendu-pottekkat commented on PR #9367:
URL: https://github.com/apache/apisix/pull/9367#issuecomment-1521082503

   @kayx23 Could you check the failing lint check? Ready to merge after that.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [apisix] kayx23 commented on pull request #9367: docs: updated description for Stream Proxy

Posted by "kayx23 (via GitHub)" <gi...@apache.org>.
kayx23 commented on PR #9367:
URL: https://github.com/apache/apisix/pull/9367#issuecomment-1521086638

   @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 the main branch. This was resulted from directing 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? 
   
   Wonder what the suggested practice/workflow is here? 


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [apisix] kayx23 commented on pull request #9367: docs: updated description for Stream Proxy

Posted by "kayx23 (via GitHub)" <gi...@apache.org>.
kayx23 commented on PR #9367:
URL: https://github.com/apache/apisix/pull/9367#issuecomment-1521078770

   @navendu-pottekkat @Neilblaze @moonming can any mod help with approval? Thx!


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [apisix] kayx23 commented on pull request #9367: docs: updated description for Stream Proxy

Posted by "kayx23 (via GitHub)" <gi...@apache.org>.
kayx23 commented on PR #9367:
URL: https://github.com/apache/apisix/pull/9367#issuecomment-1521155723

   > 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.
   
   > next
   
   ok understood


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org