Whiskine commented on code in PR #51980: URL: https://github.com/apache/airflow/pull/51980#discussion_r2159882661
########## docs/README.md: ########## @@ -164,8 +164,8 @@ This workflow also invalidates cache in Fastly that Apache Software Foundation u 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. -Shortly after the workflow succeeds and documentation is published, in live bucket, the `airflow-site-archive` -repository is automatically synchronized with the live S3 bucket. TODO: IMPLEMENT THIS, FOR NOW IT HAS +Shortly after the workflow succeeds and documentation is published, in the live bucket, the `airflow-site-archive` +repository is automatically synchronized with the live S3 bucket. TO-DO: IMPLEMENT THIS, FOR NOW IT HAS Review Comment: done! ########## docs/README.md: ########## @@ -38,44 +38,44 @@ # Documentation configuration This directory used to contain all the documentation files for the project. The documentation has -been split to separate folders - the documentation is now in the folders in sub-projects that they +been split into separate folders - the documentation is now in the folders in sub-projects that they are referring to. -If you look for the documentation it is stored as follows: +If you look for the documentation, it is stored as follows: Documentation in separate distributions: * `airflow-core/docs` - documentation for Airflow Core * `providers/**/docs` - documentation for Providers -* `chart/docs` - documentation for Helm Chart +* `chart/docs` - documentation for the Helm Chart * `task-sdk/docs` - documentation for Task SDK (new format not yet published) * `airflow-ctl/docs` - documentation for Airflow CLI (future) -Documentation for general overview and summaries not connected with any specific distribution: +Documentation for a general overview and summaries not connected with any specific distribution: * `docker-stack-docs` - documentation for Docker Stack' -* `providers-summary-docs` - documentation for provider summary page +* `providers-summary-docs` - documentation for the provider summary page # Architecture of documentation for Airflow -Building documentation for Airflow is optimized for speed and for convenience workflows of the release -managers and committers who publish and fix the documentation - that's why it's a little complex, as we have -multiple repositories and multiple sources of the documentation involved. +Building documentation for Airflow is optimized for speed and for the convenience workflows of the release +managers and committers who publish and fix the documentation - that's why it's a little complex, as we have +multiple repositories and multiple sources of documentation involved. -There are few repositories under `apache` organization which are used to build the documentation for Airflow: +There are a few repositories under `apache` organization that are used to build the documentation for Airflow: * `apache-airflow` - the repository with the code and the documentation sources for Airflow distributions, - provider distributions, providers summary and docker summary: [apache-airflow](https://github.com/apache/airflow) - from here we publish the documentation to S3 bucket where the documentation is hosted. + provider distributions, provider's summary, and docker summary: [apache-airflow](https://github.com/apache/airflow). + From here, we publish the documentation to an S3 bucket where the documentation is hosted. * `airflow-site` - the repository with the website theme and content where we keep sources of the website - structure, navigation, theme for the website [airflow-site](https://github.com/apache/airflow). From here - we publish the website to the ASF servers so they are publish as the [official website](https://airflow.apache.org) + structure, navigation, and theme for the website [airflow-site](https://github.com/apache/airflow). From here, Review Comment: updated the link^^ -- 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]
