You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2022/02/18 16:50:04 UTC

[GitHub] [apisix] navendu-pottekkat opened a new issue #6380: docs: Discrepancies in "Getting Started" and "How to build Apache APISIX" pages

navendu-pottekkat opened a new issue #6380:
URL: https://github.com/apache/apisix/issues/6380


   ### Improved or typo fixed.
   
   The "[Getting Started](https://apisix.apache.org/docs/apisix/getting-started)" page walks the user through an installation of APISIX using Docker. It is however mentioned [here](https://github.com/apache/apisix-docker#readme) that these Docker images are not official ASF images and users should always build from source.
   
   There isn't a link to other installation methods in the "Getting Started" page.
   
   There isn't an "Installation" page but instead "[How to build Apache APISIX](https://apisix.apache.org/docs/apisix/how-to-build)" which might be misleading as readers might think that it would be a guide to build the source for say, development purposes.
   
   ### Solution
   
   Proposal:
   
   1. Change "Getting Started" to "Quick Start" and make the intent clear that it is a guide to quickly run APISIX and test/play-around with it.
   2. Add more internal links to the new "Quick Start" guide pointing people to other installation methods and end-to-end guides (future).
   3. Change "How to build Apache APISIX" to "Installation" and provide a comprehensive guide on installing APISIX via different methods.
   4. Other suggestions?


-- 
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 closed issue #6380: docs: Discrepancies in "Getting Started" and "How to build Apache APISIX" pages

Posted by GitBox <gi...@apache.org>.
juzhiyuan closed issue #6380:
URL: https://github.com/apache/apisix/issues/6380


   


-- 
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 issue #6380: docs: Discrepancies in "Getting Started" and "How to build Apache APISIX" pages

Posted by GitBox <gi...@apache.org>.
navendu-pottekkat commented on issue #6380:
URL: https://github.com/apache/apisix/issues/6380#issuecomment-1045783529


   Yes. It does describe that. I am new to the project and it wasn't super obvious to me that "How to build Apache APISIX" was something I need to know as a user. I assumed it would be for customisations only and using the Docker image was the recommended way to get started.
   
   But to your point, we could maybe change it to "Installation and Custom Builds" or something along those lines. What do you think?
   
   Otherwise we can keep it as "Building Apache APISIX".


-- 
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 issue #6380: docs: Discrepancies in "Getting Started" and "How to build Apache APISIX" pages

Posted by GitBox <gi...@apache.org>.
navendu-pottekkat commented on issue #6380:
URL: https://github.com/apache/apisix/issues/6380#issuecomment-1045714993


   My intention with this change was to direct users to other installation methods as well in the "Getting Started" guide. Now that I think about it, the title could remain unchanged and we can interlink each of the two pages.
   
   Do you think there is a specific reason why "How to build Apache APISIX" should not be changed to installation?


-- 
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] jwrookie commented on issue #6380: docs: Discrepancies in "Getting Started" and "How to build Apache APISIX" pages

Posted by GitBox <gi...@apache.org>.
jwrookie commented on issue #6380:
URL: https://github.com/apache/apisix/issues/6380#issuecomment-1045684798


   LGTM, but change `Getting Started` and  `How to build Apache APISIX`  titile maybe not significant.
   
   welcome to discuss.


-- 
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 issue #6380: docs: Discrepancies in "Getting Started" and "How to build Apache APISIX" pages

Posted by GitBox <gi...@apache.org>.
navendu-pottekkat commented on issue #6380:
URL: https://github.com/apache/apisix/issues/6380#issuecomment-1044824684


   I can open up a PR after we discuss these proposed changes.


-- 
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 edited a comment on issue #6380: docs: Discrepancies in "Getting Started" and "How to build Apache APISIX" pages

Posted by GitBox <gi...@apache.org>.
navendu-pottekkat edited a comment on issue #6380:
URL: https://github.com/apache/apisix/issues/6380#issuecomment-1045714993


   My intention with this change was to direct users to other installation methods as well in the "Getting Started" guide. Now that I think about it, the title could remain unchanged and we can interlink each of the two pages.
   
   @jwrookie Do you think there is a specific reason why "How to build Apache APISIX" should not be changed to installation?


-- 
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] jwrookie commented on issue #6380: docs: Discrepancies in "Getting Started" and "How to build Apache APISIX" pages

Posted by GitBox <gi...@apache.org>.
jwrookie commented on issue #6380:
URL: https://github.com/apache/apisix/issues/6380#issuecomment-1045744660


   According to the guide, it describes different ways to install and also how to build a custom `apisix`, so I think the existing title might be better, don't you?


-- 
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] kwanhur commented on issue #6380: docs: Discrepancies in "Getting Started" and "How to build Apache APISIX" pages

Posted by GitBox <gi...@apache.org>.
kwanhur commented on issue #6380:
URL: https://github.com/apache/apisix/issues/6380#issuecomment-1046042569


   Definitely point out potential users with the two pages, then discuss how to express precisely could be better.
   
   `getting-started` for the viewers how to have a try.
   
    `how-to-build` seems for those users who want to build and install with different ways, it supports building guides and installation guides.


-- 
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 issue #6380: docs: Discrepancies in "Getting Started" and "How to build Apache APISIX" pages

Posted by GitBox <gi...@apache.org>.
navendu-pottekkat commented on issue #6380:
URL: https://github.com/apache/apisix/issues/6380#issuecomment-1046044436


   I will draft a PR and we can discuss further changes there. It would be best to have something tangible to work with.


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