Skip to content

Create a documentation package for Docker image#14765

Merged
mik-laj merged 5 commits into
apache:masterfrom
mik-laj:docker-image-docs
Mar 17, 2021
Merged

Create a documentation package for Docker image#14765
mik-laj merged 5 commits into
apache:masterfrom
mik-laj:docker-image-docs

Conversation

@mik-laj
Copy link
Copy Markdown
Member

@mik-laj mik-laj commented Mar 13, 2021

Depends on: #14762
Close: #14644 (comment)

I am extracting documentation for Docker image as a new documentation package to clearly separate documentation for apache-airflow pip package I Docker Image. Even though it is related, it is not the same. Docker Image is built on top of the apache-aiirflow package. Like the Helm Chart it is built on top of Docker Image.

This package has no versioning as its content is applicable to both Airflow 1.10 and Airflow 2.0.

For now, I have tried to limit the changes to the content to make sure everything was successfully migrated to the new package.


^ Add meaningful description above

Read the Pull Request Guidelines for more information.
In case of fundamental code change, Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in UPDATING.md.

Comment thread docs/docker-stack/entrypoint.rst Outdated
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section seems to have a lot of repetition with the following sections but I will update that in the next PR.

Comment thread docs/docker-stack/entrypoint.rst Outdated
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not true for the image for Airflow 2.0. For Airflow 2.o, we use airflow db check command.

Comment thread docs/docker-stack/entrypoint.rst Outdated
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is not supported.

@mik-laj mik-laj requested a review from potiuk March 13, 2021 23:44
Comment thread docs/docker-stack/build.rst Outdated
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We had these examples repeated twice in the documentation - once in the "Customizing the image" section and the second time under the tables in the "Production image build arguments" section. Some examples were common and some were different. Now we have one place with examples.

Comment thread docs/docker-stack/entrypoint.rst Outdated
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This page contains a combination of content from several sections, incl., Using the production image, Actions executed at image start. It's not the best idea, but seems sufficient for now. I would like to write the "Using the production image" section a little differently so that the user can actually run Airflow after reading this page and that there would not be so much duplicate information.

@mik-laj mik-laj changed the title Docker image docs Create a documentation package for Docker image Mar 13, 2021
@mik-laj mik-laj force-pushed the docker-image-docs branch from a4cc404 to 73fc44f Compare March 14, 2021 00:11
Comment thread docs/apache-airflow/installation.rst Outdated
Comment thread docs/apache-airflow/production-deployment.rst Outdated
@github-actions
Copy link
Copy Markdown
Contributor

The PR is likely ready to be merged. No tests are needed as no important environment files, nor python files were modified by it. However, committers might decide that full test matrix is needed and add the 'full tests needed' label. Then you should rebase it to the latest master or amend the last commit of the PR, and push it with --force-with-lease.

@github-actions github-actions Bot added the okay to merge It's ok to merge this PR as it does not require more tests label Mar 16, 2021
Comment thread docs/docker-stack/entrypoint.rst Outdated
Copy link
Copy Markdown
Member

@kaxil kaxil left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good, thanks @mik-laj -- some minor suggestions added

Co-authored-by: Kaxil Naik <kaxilnaik@gmail.com>
@mik-laj mik-laj merged commit 03d3c7d into apache:master Mar 17, 2021
potiuk added a commit to potiuk/airflow that referenced this pull request Mar 18, 2021
potiuk added a commit that referenced this pull request Mar 18, 2021
mik-laj added a commit to mik-laj/airflow that referenced this pull request Mar 20, 2021
@jwitz
Copy link
Copy Markdown
Contributor

jwitz commented Apr 6, 2021

@mik-laj Is this published on the web yet? I can't seem to find it.

@kaxil
Copy link
Copy Markdown
Member

kaxil commented Apr 6, 2021

@mik-laj Is this published on the web yet? I can't seem to find it.

It is at http://apache-airflow-docs.s3-website.eu-central-1.amazonaws.com/docs/docker-stack/index.html

You can find the latest docs (docs from Master) at s.apache.org/airflow-docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kind:documentation okay to merge It's ok to merge this PR as it does not require more tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Hard-to-find documentation for a Docker image

4 participants