SameerMesiah97 commented on code in PR #66950: URL: https://github.com/apache/airflow/pull/66950#discussion_r3245014705
########## docs/README.md: ########## @@ -84,7 +83,7 @@ We have two S3 buckets where we can publish the documentation generated from the Note that those S3 buckets are not served directly to Apache Server, but they are served via Cloudfront in order to provide caching and automated resolution of folders into index.html files. -The cloudfront distributions of ours are: +Our CloudFront distributions are: * Live cloudfront url: https://d7fnmbhf26p21.cloudfront.net Review Comment: ```suggestion * Live CloudFront url: https://d7fnmbhf26p21.cloudfront.net ``` ########## docs/README.md: ########## @@ -137,8 +136,7 @@ When the release manager publishes the documentation, they choose `auto` destina tag they use - `staging` will be used to publish from pre-release tag and `live` will be used to publish from the release tag. -You can also specify whether `live` or `staging` documentation should be published manually - overriding -the auto-detection. +You can also manually specify whether documentation should be published to `live` or `staging`, overriding the auto-detection. Review Comment: ```suggestion You can also specify whether documentation should be published to `live` or `staging`, thereby overriding the auto-detection. ``` ########## docs/README.md: ########## @@ -84,7 +83,7 @@ We have two S3 buckets where we can publish the documentation generated from the Note that those S3 buckets are not served directly to Apache Server, but they are served via Cloudfront in order to provide caching and automated resolution of folders into index.html files. -The cloudfront distributions of ours are: +Our CloudFront distributions are: * Live cloudfront url: https://d7fnmbhf26p21.cloudfront.net * Staging cloudfront url: https://d3a2du7x0n8ydr.cloudfront.net Review Comment: ```suggestion * Staging CloudFront url: https://d3a2du7x0n8ydr.cloudfront.net ``` ########## docs/README.md: ########## @@ -174,8 +172,8 @@ The `staging` documentation is produced automatically with `staging` watermark a  This workflow also invalidates cache in Fastly that Apache Software Foundation uses to serve the website, -so you should always run it after you modify the documentation for the website. Other than that Fastly is -configured with 3600 seconds TTL - which means that changes will propagate to the website in ~1 hour. +so you should always run it after you modify the documentation for the website. Fastly is configured with a +3600-second TTL, which means that changes may take up to about one hour to propagate to the website. Review Comment: ```suggestion 3600-second TTL, which means that changes may take up to ~1 hour to propagate to the website. ``` ########## docs/README.md: ########## @@ -39,10 +39,9 @@ # Documentation configuration This directory used to contain all the documentation files for the project. The documentation has -been split into separate folders - the documentation is now in the folders in sub-projects that they -are referring to. +been split into separate folders - the documentation is now stored in the folders of the sub-projects it refers to. Review Comment: ```suggestion been split into separate folders; the documentation is now stored in the folders of the sub-projects it refers to. ``` -- 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]
