Skip to content

Simplify publishing of documentation#12892

Merged
kaxil merged 2 commits into
apache:masterfrom
PolideaInternal:publish-docs
Dec 9, 2020
Merged

Simplify publishing of documentation#12892
kaxil merged 2 commits into
apache:masterfrom
PolideaInternal:publish-docs

Conversation

@mik-laj

@mik-laj mik-laj commented Dec 7, 2020

Copy link
Copy Markdown
Member

Close: #11423
Close: #11152

Depends on: apache/airflow-site#318

This is a small automation to make publishing documentation for multiple packages easier.


^ 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 dev/README_RELEASE_AIRFLOW.md Outdated
Comment thread dev/README_RELEASE_AIRFLOW.md Outdated
Comment thread dev/README_RELEASE_AIRFLOW.md Outdated
Comment thread dev/README_RELEASE_PROVIDER_PACKAGES.md Outdated
Comment thread dev/README_RELEASE_PROVIDER_PACKAGES.md Outdated

@kaxil kaxil left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Minor changes requested

@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 Dec 8, 2020
@github-actions

github-actions Bot commented Dec 8, 2020

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.

@kaxil

kaxil commented Dec 8, 2020

Copy link
Copy Markdown
Member

ping @mik-laj This PR is good to go -- just few minor suggestions.

Co-authored-by: Kaxil Naik <kaxilnaik@gmail.com>
The documentation is available on:
https://airflow.apache.org/
https://airflow.apache.org/docs/${VERSION}/
https://airflow.apache.org/docs/apache-airflow/${VERSION}/

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Something about having airflow appear in the URL twice bugs me unduly, but I don't really have an alternate suggestion (and I agree that having providers separately is right)

Oh well.

@mik-laj mik-laj Dec 8, 2020

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.

I also have no idea for a better directory structure. Now we will be able to create a documentation link easily based on the package name in the pypi repository.

https://airflow.apache.org/docs/${PYPI-NAME}/${VERSION}/

@kaxil

kaxil commented Dec 8, 2020

Copy link
Copy Markdown
Member

Should we merge apache/airflow-site#318 and this one @mik-laj

@mik-laj

mik-laj commented Dec 8, 2020

Copy link
Copy Markdown
Member Author

@kaxil We can merge this PR now. apache/airflow-site#318 should be merged with the first release of the documentation, as there is a new layour for the /docs/ page.

@kaxil kaxil merged commit e595d35 into apache:master Dec 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:dev-tools 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.

Separate out documentation building and publishing per provider Documentation for our many products

3 participants