Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create a new documentation package for Helm Chart #14643

Merged
merged 3 commits into from
Mar 6, 2021

Conversation

mik-laj
Copy link
Member

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

Part of: #14303

I have extracted the documentation from README.md to a separate package to make it easier for us to publish it on the site. This will also facilitate our documentation development as we have several files and not just one file. Previously, contributors didn't always add documentation to avoid cluttering the README.md file, which was already getting very long.'

For now, I have limited the changes I made to the content to make sure everything was moved, but in the following PR, we should update the content a bit more, eg decide how we will build the "Parameters" section.


^ 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.

docs/helm-chart/keda.rst Outdated Show resolved Hide resolved
Copy link
Member

@turbaszek turbaszek left a comment

Choose a reason for hiding this comment

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

One small comment but otherwise this looks amazing! Thanks @mik-laj 🐈

@github-actions
Copy link

github-actions bot commented Mar 6, 2021

The PR is likely OK to be merged with just subset of tests for default Python and Database versions without running the full matrix of tests, because it does not modify the core of Airflow. If the committers decide that the full tests matrix is needed, they will add the label 'full tests needed'. Then you should rebase 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 6, 2021
Co-authored-by: Tomek Urbaszek <[email protected]>
Copy link
Member

@ashb ashb left a comment

Choose a reason for hiding this comment

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

Love this idea!

docs/helm-chart/keda.rst Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:helm-chart Airflow Helm Chart 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.

3 participants