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

[AIRFLOW-XXXX] Google Season of Docs updates to CONTRIBUTING doc #6283

Merged
merged 1 commit into from
Oct 13, 2019

Conversation

potiuk
Copy link
Member

@potiuk potiuk commented Oct 8, 2019

Make sure you have checked all steps below.

Jira

  • In case you are fixing a typo in the documentation you can prepend your commit with [AIRFLOW-XXX], code changes always need a Jira issue.

Description

  • Here are some details about my PR, including screenshots of any UI changes:

This is first part of improvements coming from @ElenaFedotova as part of Google Season of Docs initiative.

This is quite a big change in structure and content of the documentation (including format change). You can see the diff between the old and new doc content here:

https://www.diffchecker.com/LWDaX6bW

I hope this is a nice step to improve our "contributing" documentation.

Commits

  • My commits all reference Jira issues in their subject lines, and I have squashed multiple commits if they address the same issue. In addition, my commits follow the guidelines from "

Documentation

  • In case of new functionality, my PR adds documentation that describes how to use it.

CONTRIBUTING.rst Outdated Show resolved Hide resolved
CONTRIBUTING.rst Outdated Show resolved Hide resolved
CONTRIBUTING.rst Outdated Show resolved Hide resolved
@codecov-io
Copy link

codecov-io commented Oct 8, 2019

Codecov Report

Merging #6283 into master will decrease coverage by 0.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #6283      +/-   ##
==========================================
- Coverage   80.34%   80.33%   -0.02%     
==========================================
  Files         616      616              
  Lines       35738    35738              
==========================================
- Hits        28714    28709       -5     
- Misses       7024     7029       +5
Impacted Files Coverage Δ
airflow/models/taskinstance.py 93.26% <0%> (-0.51%) ⬇️
airflow/utils/dag_processing.py 56.55% <0%> (-0.35%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 51f8bbc...d869237. Read the comment docs.

CONTRIBUTING.rst Outdated Show resolved Hide resolved
CONTRIBUTING.rst Outdated Show resolved Hide resolved
CONTRIBUTING.rst Outdated Show resolved Hide resolved
CONTRIBUTING.rst Outdated Show resolved Hide resolved
CONTRIBUTING.rst Outdated Show resolved Hide resolved
@kaxil
Copy link
Member

kaxil commented Oct 10, 2019

In the first commit msg

- Co-authored-by: Elena Fedotova <lavel@mail.ru>>
+ Co-authored-by: Elena Fedotova <lavel@mail.ru>

@potiuk
Copy link
Member Author

potiuk commented Oct 13, 2019

I just rebased this change on top of the latest master and squashed all the changes (leaving co-authors ;).

@ashb @kaxil @mik-laj -> I think this one is quite ready to be merged (I like it a lot more now :). We have few things that we work with @efedotova on #6285 which will further update the CONTRIBUTING.rst. One of the things is to move the "testing" section from Breeze to CONTRIBUTING so I'd love to merge this one and rebase the $6285 on top of it.

One thing to note - we've changed the format/URL of CONTRIBUTING.md to .rst (which is a good thing) but maybe a sensible approach will be to leave CONTRIBUTING.md with link to CONTRIBUTING.rst rather than delete CONTRIBUTING.md ? There are some slack messages and other places pointing to the old CONTRIBUTING.md I am afraid.

What do you think ?
Can you review and approve please :).

@potiuk potiuk force-pushed the gsod-contributing branch 2 times, most recently from 46a3c74 to eab3666 Compare October 13, 2019 06:18
@potiuk
Copy link
Member Author

potiuk commented Oct 13, 2019

I've added the note to Contribuing.md and updated the links in Airflow's code.

@potiuk
Copy link
Member Author

potiuk commented Oct 13, 2019

I also reviewed and updated all the cross-links to different sections of both CONTRIBUTING and BREEZE

Co-authored-by: Elena Fedotova <lavel@mail.ru>
Co-Authored-By: Kamil Breguła <mik-laj@users.noreply.github.com>
Co-Authored-By: Kaxil Naik <kaxilnaik@gmail.com>
Co-Authored-By: Ash Berlin-Taylor <ash_github@firemirror.com>
@potiuk potiuk merged commit 10d39ef into apache:master Oct 13, 2019
potiuk added a commit that referenced this pull request Oct 20, 2019
Co-authored-by: Elena Fedotova <lavel@mail.ru>
Co-Authored-By: Kamil Breguła <mik-laj@users.noreply.github.com>
Co-Authored-By: Kaxil Naik <kaxilnaik@gmail.com>
Co-Authored-By: Ash Berlin-Taylor <ash_github@firemirror.com>
(cherry picked from commit 10d39ef)
kaxil pushed a commit that referenced this pull request Oct 22, 2019
Co-authored-by: Elena Fedotova <lavel@mail.ru>
Co-Authored-By: Kamil Breguła <mik-laj@users.noreply.github.com>
Co-Authored-By: Kaxil Naik <kaxilnaik@gmail.com>
Co-Authored-By: Ash Berlin-Taylor <ash_github@firemirror.com>
(cherry picked from commit 10d39ef)
ashb pushed a commit that referenced this pull request Oct 25, 2019
Co-authored-by: Elena Fedotova <lavel@mail.ru>
Co-Authored-By: Kamil Breguła <mik-laj@users.noreply.github.com>
Co-Authored-By: Kaxil Naik <kaxilnaik@gmail.com>
Co-Authored-By: Ash Berlin-Taylor <ash_github@firemirror.com>
(cherry picked from commit 10d39ef)
potiuk added a commit that referenced this pull request Nov 12, 2019
Co-authored-by: Elena Fedotova <lavel@mail.ru>
Co-Authored-By: Kamil Breguła <mik-laj@users.noreply.github.com>
Co-Authored-By: Kaxil Naik <kaxilnaik@gmail.com>
Co-Authored-By: Ash Berlin-Taylor <ash_github@firemirror.com>
(cherry picked from commit 10d39ef)
eladkal pushed a commit to eladkal/airflow that referenced this pull request Dec 2, 2019
…che#6283)

Co-authored-by: Elena Fedotova <lavel@mail.ru>
Co-Authored-By: Kamil Breguła <mik-laj@users.noreply.github.com>
Co-Authored-By: Kaxil Naik <kaxilnaik@gmail.com>
Co-Authored-By: Ash Berlin-Taylor <ash_github@firemirror.com>
(cherry picked from commit 10d39ef)
kaxil pushed a commit that referenced this pull request Dec 12, 2019
Co-authored-by: Elena Fedotova <lavel@mail.ru>
Co-Authored-By: Kamil Breguła <mik-laj@users.noreply.github.com>
Co-Authored-By: Kaxil Naik <kaxilnaik@gmail.com>
Co-Authored-By: Ash Berlin-Taylor <ash_github@firemirror.com>
(cherry picked from commit 10d39ef)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants