Re: API Reference - current confusion and improvement plan

2019-04-01 Thread Ash Berlin-Taylor
CommentId=16803866&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-16803866 > > > Best wish. > -- Jiajie > > From: Ash Berlin-Taylor > Sent: Friday, March 29, 2019 23:16 > To: dev@airflow.apache.org > Subject: Re: API Reference

Re: API Reference - current confusion and improvement plan

2019-03-29 Thread Jiajie Zhong
-- Jiajie From: Ash Berlin-Taylor Sent: Friday, March 29, 2019 23:16 To: dev@airflow.apache.org Subject: Re: API Reference - current confusion and improvement plan It took pulling in about another 30 commits to get it without conflicts but I've pulled this in to the v1-10-stable branch

Re: API Reference - current confusion and improvement plan

2019-03-29 Thread Ash Berlin-Taylor
g wrote: > > Thanks Kamil, really a great change in out documentation > > > Best wish. > -- Jiajie > > > From: Driesprong, Fokko > Sent: Friday, March 29, 2019 19:16 > To: dev@airflow.apache.org > Subject: Re: API Refere

Re: API Reference - current confusion and improvement plan

2019-03-29 Thread Jiajie Zhong
Thanks Kamil, really a great change in out documentation Best wish. -- Jiajie From: Driesprong, Fokko Sent: Friday, March 29, 2019 19:16 To: dev@airflow.apache.org Subject: Re: API Reference - current confusion and improvement plan Awesome work Kamil. Thanks

Re: API Reference - current confusion and improvement plan

2019-03-29 Thread Driesprong, Fokko
Awesome work Kamil. Thanks for giving some love to the documentation. It really needed some :-) Don't forget to remove the line from the Github template: When adding new operators/hooks/sensors, the autoclass documentation generation needs to be added. https://github.com/apache/airflow/blob/master

Re: API Reference - current confusion and improvement plan

2019-03-26 Thread Kamil Breguła
Hi. Work on this has been completed. New documentation is available: https://airflow.readthedocs.io/en/latest/_api/index.html Greetings Kamil Breguła On Wed, Feb 27, 2019 at 12:51 PM Kamil Breguła wrote: > > Hi. > > Me and Jarek Potiuk have recently worked to finish these changes. As a > resul

Re: API Reference - current confusion and improvement plan

2019-02-27 Thread Kamil Breguła
Hi. Me and Jarek Potiuk have recently worked to finish these changes. As a result, a PR series was created: - [AIRFLOW-XXX][1/3] Syntax docs improvements - https://github.com/apache/airflow/pull/4789 - [AIRFLOW-3968][2/3] Refactor base GCP hook - https://github.com/apache/airflow/pull/4790 - [AIR

Re: API Reference - current confusion and improvement plan

2019-02-06 Thread Szymon Przedwojski
+1 I also like the new docs layout and the big win is that it’s generated automatically from all files and we won’t have to modify code.rst / integration.rst manually anymore. Szymon Przedwojski Polidea | Software Engineer M: +48 500 330 790 E: szymon.przedwoj...@polidea.com > On 5 Feb 2019,

Re: API Reference - current confusion and improvement plan

2019-02-05 Thread Ash Berlin-Taylor
I have idly wondered about something like this as a layout from airflow.$something.aws.operators import EmrAddStepOperator - Grouping by service provider is more helpful - Having more than one operator per module - Not having `_operator` (etc.) suffix on the modue, and the class, and the mod

Re: API Reference - current confusion and improvement plan

2019-02-05 Thread Kamil Breguła
I think that we should group operators by service (ex. Amazon Web Service: Simple Cloud Storage). One module to one service. it will be much easier to navigate through them. A similar problem occurs with the Google Cloud Storage service, but we have a solution (PR: https://github.com/apache/airflow

Re: API Reference - current confusion and improvement plan

2019-02-05 Thread Felix Uellendall
+1 I love it. :)) Am 05/02/2019 um 21:03 schrieb Kaxil Naik: +1 I like this On Tue, Feb 5, 2019, 19:59 Tao Feng +1 as well, I like the layout for the new doc. On Tue, Feb 5, 2019 at 11:57 AM Ash Berlin-Taylor wrote: I like the API reference v2 layout a lot! Much easier to navigate and see

Re: API Reference - current confusion and improvement plan

2019-02-05 Thread Kaxil Naik
+1 I like this On Tue, Feb 5, 2019, 19:59 Tao Feng +1 as well, I like the layout for the new doc. > > On Tue, Feb 5, 2019 at 11:57 AM Ash Berlin-Taylor wrote: > > > I like the API reference v2 layout a lot! Much easier to navigate and see > > what classes are available, for me at least > > > > D

Re: API Reference - current confusion and improvement plan

2019-02-05 Thread Tao Feng
+1 as well, I like the layout for the new doc. On Tue, Feb 5, 2019 at 11:57 AM Ash Berlin-Taylor wrote: > I like the API reference v2 layout a lot! Much easier to navigate and see > what classes are available, for me at least > > Documenting modules will help somewhat with a few things but, lets

Re: API Reference - current confusion and improvement plan

2019-02-05 Thread Ash Berlin-Taylor
I like the API reference v2 layout a lot! Much easier to navigate and see what classes are available, for me at least Documenting modules will help somewhat with a few things but, lets say the "AWS" section of the integration doc is across the following modules: airflow.contrib.operators.aws_at

Re: API Reference - current confusion and improvement plan

2019-02-05 Thread Kamil Breguła
I already have a POC: :-) Available at: http://level-can.surge.sh/html/autoapi/index.html I would like to point out that in addition to class documentation, you can also document modules. http://level-can.surge.sh/html/autoapi/airflow/executors/local_executor/index.html Currently, the `howto/oper

Re: API Reference - current confusion and improvement plan

2019-02-05 Thread Ash Berlin-Taylor
> We want to rewrite the `integration.rst` file so that it does not contain > duplicates from `code.rst ' (API Reference). In the next step, introduce > the reference API generation based on the source code that will replace the > `code.rst` file. :100: Yes please! Given a number of integrations

API Reference - current confusion and improvement plan

2019-02-05 Thread Kamil Breguła
Hello community, While working on the documentation for the GCP operators, my team at Polidea encountered some confusion related to the structure of the documentation. Short story: We want to rewrite the `integration.rst` file so that it does not contain duplicates from `code.rst ' (API Referenc