airflow-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Naik Kaxil <>
Subject Re: Where to put docs on configuring specific kinds of connections? (Or restructuring the docs the way Django does)
Date Tue, 22 May 2018 08:30:39 GMT
Hi Tim,

My personal opinion is to write the docs on GCP connection down at GCP Integration page <>
would be an ideal fit but would like to hear others opinion as well.

+1 for creating separate How-To guides.


On 21/05/2018, 21:35, "Tim Swast" <> wrote:

    Hey folks,
    I'd like to write some docs on how to create a GCP connection (and leave
    room for documenting other kinds of connections as well). Currently it
    seems like there are a couple places such a thing could fit:
    There's also the concepts guide, but I definitely don't think that's the
    right place for documenting a specific task like this.
    There's a principle I'm used to following with the GCP docs, that the distinct
    kinds of documentation
    should be organized separately. The Django project does this by splitting into
       - Tutorials
       - Topic guides (what Airflow calls Concepts)
       - Reference guides
       - How-to guides
    I'd like to propose we split some of the existing "Configuration" topics
    into separate how-to guides. What do you think?
    Meta: Should I create JIRA issues for this kind of pre-discussion or start
    here as I've done?
    *  •  **Tim Swast*
    *  •  *Software Friendliness Engineer
    *  •  *Google Cloud Developer Relations
    *  •  *Seattle, WA, USA

Kaxil Naik 

Data Reply
2nd Floor, Nova South
160 Victoria Street, Westminster
London SW1E 5LB - UK 
phone: +44 (0)20 7730 6000
View raw message