You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by GitBox <gi...@apache.org> on 2022/11/15 05:19:53 UTC
[GitHub] [airflow] amoghrajesh opened a new pull request, #27677: Update build.rst for docker compose and helm chart
amoghrajesh opened a new pull request, #27677:
URL: https://github.com/apache/airflow/pull/27677
The links are broken for the docker compose and helm charts on the build instructions file
<!--
Thank you for contributing! Please make sure that your code changes
are covered with tests. And in case of new features or big changes
remember to adjust the documentation.
Feel free to ping committers for the review!
In case of an existing issue, reference it using one of the following:
closes: #ISSUE
related: #ISSUE
How to write a good git commit message:
http://chris.beams.io/posts/git-commit/
-->
The docker compose file and helm-charts links are broken on the build documentation page: https://airflow.apache.org/docs/docker-stack/build.html#
This PR fixes the broken links with the appropriate ones.
---
**^ Add meaningful description above**
Read the **[Pull Request Guidelines](https://github.com/apache/airflow/blob/main/CONTRIBUTING.rst#pull-request-guidelines)** for more information.
In case of fundamental code changes, an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals)) is needed.
In case of a new dependency, check compliance with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
In case of backwards incompatible changes please leave a note in a newsfragment file, named `{pr_number}.significant.rst` or `{issue_number}.significant.rst`, in [newsfragments](https://github.com/apache/airflow/tree/main/newsfragments).
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] amoghrajesh commented on pull request #27677: Update build.rst for docker compose and helm chart
Posted by GitBox <gi...@apache.org>.
amoghrajesh commented on PR #27677:
URL: https://github.com/apache/airflow/pull/27677#issuecomment-1315478420
@potiuk just made a fix and pushed the latest commit now. Testing using the below command:
```
➜ airflow git:(patch-1) ✗ breeze build-docs --package-filter docker-stack
Good version of Docker: 20.10.12.
Good version of docker-compose: 1.29.2
Good Docker context used: default.
Docker image build is not needed for CI build as no important files are changed! You can add --force-build to force it
Running Initialization. Your basic configuration is:
* Airflow home: /root/airflow
* Airflow sources: /opt/airflow
* Airflow core SQL connection:
Using airflow version from current sources
Checking integrations and backends.
Skip fixing ownership of generated files as Host OS is darwin
#################### Available packages ####################
- apache-airflow
- apache-airflow-providers
- apache-airflow-providers-airbyte
- apache-airflow-providers-alibaba
- apache-airflow-providers-amazon
- apache-airflow-providers-apache-beam
- apache-airflow-providers-apache-cassandra
- apache-airflow-providers-apache-drill
- apache-airflow-providers-apache-druid
- apache-airflow-providers-apache-hdfs
- apache-airflow-providers-apache-hive
- apache-airflow-providers-apache-kylin
- apache-airflow-providers-apache-livy
- apache-airflow-providers-apache-pig
- apache-airflow-providers-apache-pinot
- apache-airflow-providers-apache-spark
- apache-airflow-providers-apache-sqoop
- apache-airflow-providers-arangodb
- apache-airflow-providers-asana
- apache-airflow-providers-atlassian-jira
- apache-airflow-providers-celery
- apache-airflow-providers-cloudant
- apache-airflow-providers-cncf-kubernetes
- apache-airflow-providers-common-sql
- apache-airflow-providers-databricks
- apache-airflow-providers-datadog
- apache-airflow-providers-dbt-cloud
- apache-airflow-providers-dingding
- apache-airflow-providers-discord
- apache-airflow-providers-docker
- apache-airflow-providers-elasticsearch
- apache-airflow-providers-exasol
- apache-airflow-providers-facebook
- apache-airflow-providers-ftp
- apache-airflow-providers-github
- apache-airflow-providers-google
- apache-airflow-providers-grpc
- apache-airflow-providers-hashicorp
- apache-airflow-providers-http
- apache-airflow-providers-imap
- apache-airflow-providers-influxdb
- apache-airflow-providers-jdbc
- apache-airflow-providers-jenkins
- apache-airflow-providers-microsoft-azure
- apache-airflow-providers-microsoft-mssql
- apache-airflow-providers-microsoft-psrp
- apache-airflow-providers-microsoft-winrm
- apache-airflow-providers-mongo
- apache-airflow-providers-mysql
- apache-airflow-providers-neo4j
- apache-airflow-providers-odbc
- apache-airflow-providers-openfaas
- apache-airflow-providers-opsgenie
- apache-airflow-providers-oracle
- apache-airflow-providers-pagerduty
- apache-airflow-providers-papermill
- apache-airflow-providers-plexus
- apache-airflow-providers-postgres
- apache-airflow-providers-presto
- apache-airflow-providers-qubole
- apache-airflow-providers-redis
- apache-airflow-providers-salesforce
- apache-airflow-providers-samba
- apache-airflow-providers-segment
- apache-airflow-providers-sendgrid
- apache-airflow-providers-sftp
- apache-airflow-providers-singularity
- apache-airflow-providers-slack
- apache-airflow-providers-snowflake
- apache-airflow-providers-sqlite
- apache-airflow-providers-ssh
- apache-airflow-providers-tableau
- apache-airflow-providers-tabular
- apache-airflow-providers-telegram
- apache-airflow-providers-trino
- apache-airflow-providers-vertica
- apache-airflow-providers-yandex
- apache-airflow-providers-zendesk
- docker-stack
- helm-chart
Current package filters:
['docker-stack']
#################### Fetching inventories ####################
Nothing to do
#################### Documentation will be built for 1 package(s) with 6 parallel jobs ####################
1. docker-stack
#################### Cleaning documentation files ####################
docker-stack : Cleaning files
#################### Scheduling documentation to build ####################
docker-stack : Scheduling documentation to build
#################### Running docs building ####################
docker-stack : Building documentation
docker-stack : Running sphinx. The output is hidden until an error occurs.
docker-stack : Finished docs building successfully
#################### Scheduling spell checking of documentation ####################
docker-stack : Scheduling spellchecking
#################### Running spell checking of documentation ####################
docker-stack : Checking spelling started
docker-stack : Finished spell-checking successfully
docker-stack : Checking spelling completed
Documentation build is successful
```
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] boring-cyborg[bot] commented on pull request #27677: Update build.rst for docker compose and helm chart
Posted by GitBox <gi...@apache.org>.
boring-cyborg[bot] commented on PR #27677:
URL: https://github.com/apache/airflow/pull/27677#issuecomment-1316210365
Awesome work, congrats on your first merged pull request!
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] boring-cyborg[bot] commented on pull request #27677: Update build.rst for docker compose and helm chart
Posted by GitBox <gi...@apache.org>.
boring-cyborg[bot] commented on PR #27677:
URL: https://github.com/apache/airflow/pull/27677#issuecomment-1314789900
Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contribution Guide (https://github.com/apache/airflow/blob/main/CONTRIBUTING.rst)
Here are some useful points:
- Pay attention to the quality of your code (flake8, mypy and type annotations). Our [pre-commits]( https://github.com/apache/airflow/blob/main/STATIC_CODE_CHECKS.rst#prerequisites-for-pre-commit-hooks) will help you with that.
- In case of a new feature add useful documentation (in docstrings or in `docs/` directory). Adding a new operator? Check this short [guide](https://github.com/apache/airflow/blob/main/docs/apache-airflow/howto/custom-operator.rst) Consider adding an example DAG that shows how users should use it.
- Consider using [Breeze environment](https://github.com/apache/airflow/blob/main/BREEZE.rst) for testing locally, it's a heavy docker but it ships with a working Airflow and a lot of integrations.
- Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
- Please follow [ASF Code of Conduct](https://www.apache.org/foundation/policies/conduct) for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
- Be sure to read the [Airflow Coding style]( https://github.com/apache/airflow/blob/main/CONTRIBUTING.rst#coding-style-and-best-practices).
Apache Airflow is a community-driven project and together we are making it better 🚀.
In case of doubts contact the developers at:
Mailing List: dev@airflow.apache.org
Slack: https://s.apache.org/airflow-slack
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] potiuk commented on pull request #27677: Update build.rst for docker compose and helm chart
Posted by GitBox <gi...@apache.org>.
potiuk commented on PR #27677:
URL: https://github.com/apache/airflow/pull/27677#issuecomment-1316052993
Approved to see result
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] amoghrajesh commented on pull request #27677: Update build.rst for docker compose and helm chart
Posted by GitBox <gi...@apache.org>.
amoghrajesh commented on PR #27677:
URL: https://github.com/apache/airflow/pull/27677#issuecomment-1316194758
@potiuk looks like the checks have gone through. Anything more needed from my end?
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] potiuk merged pull request #27677: Update build.rst for docker compose and helm chart
Posted by GitBox <gi...@apache.org>.
potiuk merged PR #27677:
URL: https://github.com/apache/airflow/pull/27677
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] amoghrajesh commented on a diff in pull request #27677: Update build.rst for docker compose and helm chart
Posted by GitBox <gi...@apache.org>.
amoghrajesh commented on code in PR #27677:
URL: https://github.com/apache/airflow/pull/27677#discussion_r1022637480
##########
docs/docker-stack/build.rst:
##########
@@ -180,7 +180,7 @@ In the simplest case building your image consists of those steps:
In case you use some kind of registry where you will be using the image from, it is usually named
in the form of ``registry/image-name``. The name of the image has to be configured for the deployment
method your image will be deployed. This can be set for example as image name in the
- `docker-compose file <running-airflow-in-docker>`_ or in the `Helm chart <helm-chart>`_.
+ `docker-compose file <https://airflow.apache.org/docs/apache-airflow/stable/howto/docker-compose/index.html>`_ or in the `Helm chart <https://airflow.apache.org/docs/helm-chart/stable/index.html>`_.
Review Comment:
Thanks for the comment @potiuk. Adding these changes now and letting the CI go ahead with it
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] potiuk commented on pull request #27677: Update build.rst for docker compose and helm chart
Posted by GitBox <gi...@apache.org>.
potiuk commented on PR #27677:
URL: https://github.com/apache/airflow/pull/27677#issuecomment-1315187988
I've approved the workflow - watch it out and see if the docs build succeed, if not, fix the problems it will indicate.
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] potiuk commented on a diff in pull request #27677: Update build.rst for docker compose and helm chart
Posted by GitBox <gi...@apache.org>.
potiuk commented on code in PR #27677:
URL: https://github.com/apache/airflow/pull/27677#discussion_r1022610310
##########
docs/docker-stack/build.rst:
##########
@@ -180,7 +180,7 @@ In the simplest case building your image consists of those steps:
In case you use some kind of registry where you will be using the image from, it is usually named
in the form of ``registry/image-name``. The name of the image has to be configured for the deployment
method your image will be deployed. This can be set for example as image name in the
- `docker-compose file <running-airflow-in-docker>`_ or in the `Helm chart <helm-chart>`_.
+ `docker-compose file <https://airflow.apache.org/docs/apache-airflow/stable/howto/docker-compose/index.html>`_ or in the `Helm chart <https://airflow.apache.org/docs/helm-chart/stable/index.html>`_.
Review Comment:
Actually - those should Sphinx directives not URLs. Something like that (but you need to build the docs locally with `breeze build-docs` or let CI do it for you and verify if the links are correct"
```suggestion
:doc:`apache-airflow:howto/docker-compose/index` or in the :doc:`helm-chart:index>`.
```
Except automatically generating the right link - also in the local documentation, this has the added advantage that in case of documentation refactorings, Sphinx will automatically check if the links are still valid and will fail docs building if they are not
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org