yzeng25 commented on pull request #945:
URL: https://github.com/apache/apisix-website/pull/945#issuecomment-1061902191


   > > Batching all of these procedures (rename, update keywords, descriptions, 
add text contents) up in one pull request is not a wise decision. It creates 
the following problems.
   > > 
   > > 1. Once a file is renamed, its contents appear as all new during review. 
This creates trouble for reviewers. Put yourself in reviewers' shoes, how would 
you feel when you need to review a pull request with 215 files (the number of 
files in this pull request as of 17:36 GMT+8)?
   > > 2. Many of the files are ended with time stamp `2022xxxxx` suffixes. 
Please fix them.
   > >    
![gmSowKTowJ](https://user-images.githubusercontent.com/36651058/157005561-648c792d-d2cf-4090-bb6f-5479f67ae3cd.png)
   > > 3. Some of the files are already published on Medium[1] page, which also 
provides link referring back to Apache APISIX's blog[2]. Do you know changing 
all links could lead to reference failures as well?
   > > 
   > > I would suggest break this pull request into different parts and solve 
them one by one.
   > > 
   > > 1. Identify all files that can't be renamed directly for Reason 3 stated 
above. It can be solved with a trick called `slug`. Update keywords, update 
descriptions, add text contents on them. This could be a pull request.
   > > 2. Update keywords, update descriptions, add text contents for the rest 
of the files. This could be one or more pull requests, preferably submitting 
them by months or quarters.
   > > 3. Rename files in Part 2. The reason to leave the renaming at the end 
are to ease the process of review and to avoid merge conflicts. Please think of 
other contributors and other pull requests hanging there as well. This could be 
another pull request.
   > > 
   > > I know you are eager to solve this problem soon. But using brutal force 
to solve the problem just isn't the most effective way. Things are always more 
complicated than your imagination. Please think twice before you act.
   > > Please fix the lint as well, thanks!
   > > [1]https://medium.com/@ApacheAPISIX [2]https://apisix.apache.org/blog
   > 
   > 1 and 2 are both fixed. and 3 is not the issue of apisix website, and we 
can update the links in Medium after this PR merged.
   
   There are another 15 problems listed below. The cause is only renaming en-us 
blogs' names but not zh-cn blogs' names, or the other way around. Please fix 
them. 
   
   1. When renaming or adding `slug` to files, please make sure  en-us blogs' 
names and `slug`(if any) are matched up with those of zh-cn blogs'.
   2. The existing `-API-` in filenames is not acceptable, it will create 
problems of case sensitive URLs again. Please modify them to `-api-`. 
   
   Here is the list of 15 problems. 
   
   1. OPA
       1. 
https://deploy-preview-945--apache-apisix.netlify.app/zh/blog/2021/12/24/open-policy-agent-API-gateway
       4. website/blog/2021/12/22/google-logging-API-gateway.md
   3. Google Cloud Logging
       1. 
https://deploy-preview-945--apache-apisix.netlify.app/zh/blog/2021/12/22/google-logging-API-gateway
       2. website/blog/2021/12/22/google-logging-API-gateway.md
   5. Datadog
       1. 
https://deploy-preview-945--apache-apisix.netlify.app/zh/blog/2021/11/12/datadog-API-gateway
       2. website/blog/2021/11/12/datadog-API-gateway.md
   6. Observability of API gateway
       1. website/blog/2021/11/04/observability-of-api-gateway.md
       2. 
https://deploy-preview-945--apache-apisix.netlify.app/zh/blog/2021/11/04/observability-of-api-gateway/
   7. Airwallex
       1. 
https://deploy-preview-945--apache-apisix.netlify.app/zh/blog/2021/11/03/airwallex-api-gateway/
       2. website/blog/2021/11/03/airwallex-API-gateway.md
   8. WPS
       1. 
https://deploy-preview-945--apache-apisix.netlify.app/zh/blog/2021/09/28/wps-usercase
       2. website/blog/2021/09/28/WPS-API-gateway.md
   9. UPYUN
       1. 
https://deploy-preview-945--apache-apisix.netlify.app/zh/blog/2021/09/24/upyun-API-gateway
       2. website/blog/2021/09/24/upyun-API-gateway.md
   10. DIAN
       1. 
https://deploy-preview-945--apache-apisix.netlify.app/zh/blog/2021/09/18/xiaodian-API-gateway
       2. website/blog/2021/09/18/xiaodian-API-gateway.md
   11. Tencent Cloud
       1. 
https://deploy-preview-945--apache-apisix.netlify.app/zh/blog/2021/09/16/tencent-cloud-API-gateway
       2. website/blog/2021/09/16/tencent-cloud-API-gateway.md
   12. Youzanyun
       1. 
https://deploy-preview-945--apache-apisix.netlify.app/zh/blog/2021/09/14/youzan-mocroservice-API-gateway
       2. website/blog/2021/09/14/youzan-mocroservice-API-gateway.md
   13. China Mobile Cloud
       1. 
https://deploy-preview-945--apache-apisix.netlify.app/zh/blog/2021/09/13/china-mobile-cloud-api-gateway
       2. website/blog/2021/09/13/china-mobile-cloud-api-gateway.md
   14. iQiYi
       1. 
https://deploy-preview-945--apache-apisix.netlify.app/zh/blog/2021/09/07/iqiyi-api-gateway
       2. website/blog/2021/09/07/iQIYI-API-gateway.md
   15. Airwallex Interview
       1. 
https://deploy-preview-945--apache-apisix.netlify.app/zh/blog/2021/08/17/airwallex-apache-apisix
       2. website/blog/2021/08/17/airwallex-apache-apisix.md
   16. Apache APISIX Architecture Analysis
       1. 
[https://deploy-preview-945--apache-apisix.netlify.app/zh/blog/2021/08/10/dynamically-manage-Nginx-clustering](https://deploy-preview-945--apache-apisix.netlify.app/zh/blog/2021/08/16/using-the-apache-apisix-openid-connect-plugin-for-centralized-authentication)
       2. website/blog/2021/08/10/dynamically-manage-Nginx-clustering.md
   17. Hyperchain
       1. 
https://deploy-preview-945--apache-apisix.netlify.app/zh/blog/2021/08/09/apache-apisix-in-hyperchain
       2. website/blog/2021/08/09/Apache-APISIX-in-Hyperchain.md
   
   Once fixed, please examine in 
https://deploy-preview-945--apache-apisix.netlify.app/ carefully. Or it takes 
other reviewers' time to do it for you, which would very likely to slow down 
the review, approve, and merging process.


-- 
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: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


Reply via email to