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

Move Breeze documentation to inside Breeze and split it. #36936

Merged
merged 1 commit into from
Jan 21, 2024

Conversation

potiuk
Copy link
Member

@potiuk potiuk commented Jan 21, 2024

The BREEZE.rst document became enormous - enough for it to stop being rendered by GitHub. This change splits it into multiple smaller documents - each focusing on a specific aspect of Breeze, making it possible by the user to focus on only that aspect that the user is interested at.

We also add nice index that guides the user to know about all the aspects of Breeze.


^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an 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 a newsfragment file, named {pr_number}.significant.rst or {issue_number}.significant.rst, in newsfragments.

@potiuk potiuk force-pushed the split-breeze-docs branch 2 times, most recently from 87f1dad to 01f2460 Compare January 21, 2024 19:13
Copy link
Contributor

@eladkal eladkal left a comment

Choose a reason for hiding this comment

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

Nice!

@potiuk potiuk force-pushed the split-breeze-docs branch 2 times, most recently from c4ec481 to f1a5b75 Compare January 21, 2024 19:28
BREEZE.rst Outdated Show resolved Hide resolved
@potiuk potiuk force-pushed the split-breeze-docs branch from f1a5b75 to 80140e5 Compare January 21, 2024 19:52
The BREEZE.rst document became enormous - enough for it to stop being
rendered by GitHub. This change splits it into multiple smaller
documents - each focusing on a specific aspect of Breeze, making it
possible by the user to focus on only that aspect that the user
is interested at.

We also add nice index that guides the user to know about all the
aspects of Breeze.
@potiuk potiuk force-pushed the split-breeze-docs branch from 80140e5 to 8713ecf Compare January 21, 2024 20:12
@potiuk potiuk merged commit 4f48e3f into apache:main Jan 21, 2024
75 of 76 checks passed
@potiuk potiuk deleted the split-breeze-docs branch January 21, 2024 20:41
@ferruzzi
Copy link
Contributor

That was a big one, thanks for that.

potiuk added a commit that referenced this pull request Jan 23, 2024
Following #36936 and the fact that GitHub stopped rendering big .rst
files, we also split CONTRIBUTING.rst into multiplet files. It will be
much easier to follow and it will render in GitHub.
potiuk added a commit that referenced this pull request Jan 24, 2024
Following #36936 and the fact that GitHub stopped rendering big .rst
files, we also split CONTRIBUTING.rst into multiplet files. It will be
much easier to follow and it will render in GitHub.
potiuk added a commit to potiuk/airflow that referenced this pull request Jan 25, 2024
Following apache#36936 and the fact that GitHub stopped rendering big .rst
files, we also split CONTRIBUTING.rst into multiplet files. It will be
much easier to follow and it will render in GitHub.
potiuk added a commit that referenced this pull request Jan 25, 2024
Following #36936 and the fact that GitHub stopped rendering big .rst
files, we also split CONTRIBUTING.rst into multiplet files. It will be
much easier to follow and it will render in GitHub.
potiuk added a commit that referenced this pull request Jan 26, 2024
Following #36936 and the fact that GitHub stopped rendering big .rst
files, we also split CONTRIBUTING.rst into multiplet files. It will be
much easier to follow and it will render in GitHub.
potiuk added a commit that referenced this pull request Jan 26, 2024
Following #36936 and the fact that GitHub stopped rendering big .rst
files, we also split CONTRIBUTING.rst into multiplet files. It will be
much easier to follow and it will render in GitHub.
potiuk added a commit to potiuk/airflow that referenced this pull request Jan 27, 2024
This PR moves the documentation of CI of ours to inside Breeze
doc folder and splits the documentation in separate docs / chapters
following similar changes done for Breeze docs apache#36936 and the
contributing docs apache#36969.
potiuk added a commit that referenced this pull request Jan 27, 2024
This PR moves the documentation of CI of ours to inside Breeze
doc folder and splits the documentation in separate docs / chapters
following similar changes done for Breeze docs #36936 and the
contributing docs #36969.
potiuk added a commit that referenced this pull request Feb 7, 2024
The BREEZE.rst document became enormous - enough for it to stop being
rendered by GitHub. This change splits it into multiple smaller
documents - each focusing on a specific aspect of Breeze, making it
possible by the user to focus on only that aspect that the user
is interested at.

We also add nice index that guides the user to know about all the
aspects of Breeze.

(cherry picked from commit 4f48e3f)
potiuk added a commit that referenced this pull request Feb 7, 2024
Following #36936 and the fact that GitHub stopped rendering big .rst
files, we also split CONTRIBUTING.rst into multiplet files. It will be
much easier to follow and it will render in GitHub.

(cherry picked from commit 8708bff)
potiuk added a commit that referenced this pull request Feb 7, 2024
This PR moves the documentation of CI of ours to inside Breeze
doc folder and splits the documentation in separate docs / chapters
following similar changes done for Breeze docs #36936 and the
contributing docs #36969.

(cherry picked from commit 6daceb8)
@potiuk potiuk added the changelog:skip Changes that should be skipped from the changelog (CI, tests, etc..) label Feb 8, 2024
@potiuk potiuk added this to the Airflow 2.8.2 milestone Feb 8, 2024
ephraimbuddy pushed a commit that referenced this pull request Feb 22, 2024
The BREEZE.rst document became enormous - enough for it to stop being
rendered by GitHub. This change splits it into multiple smaller
documents - each focusing on a specific aspect of Breeze, making it
possible by the user to focus on only that aspect that the user
is interested at.

We also add nice index that guides the user to know about all the
aspects of Breeze.

(cherry picked from commit 4f48e3f)
ephraimbuddy pushed a commit that referenced this pull request Feb 22, 2024
Following #36936 and the fact that GitHub stopped rendering big .rst
files, we also split CONTRIBUTING.rst into multiplet files. It will be
much easier to follow and it will render in GitHub.

(cherry picked from commit 8708bff)
ephraimbuddy pushed a commit that referenced this pull request Feb 22, 2024
This PR moves the documentation of CI of ours to inside Breeze
doc folder and splits the documentation in separate docs / chapters
following similar changes done for Breeze docs #36936 and the
contributing docs #36969.

(cherry picked from commit 6daceb8)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:dev-tools changelog:skip Changes that should be skipped from the changelog (CI, tests, etc..)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants