Versions Compared

Old Version 4

changes.mady.by.user Unknown User (ash)

Saved on

compared with

New Version Current

changes.mady.by.user Unknown User (potiuk)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Status

Page properties


State
Draft
Completed
Discussion Thread[PROPOSAL] Add a landing page for Apache Airflow
JIRA

Jira
serverASF JIRA
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId5aa69414-a9e9-3523-82ec-879b028fb15b
keyAIRFLOW-3788

Created

Created

In Release1.10.7


Table of Contents
maxLevel1

Motivation

Open Source Software needs to build a community to ensure its healthy growth. One of the tools used to build a community is the web site dedicated to the product. The goal behind building an open source friendly website for Apache Airflow is to engage, inform, and educate visitors, and ultimately to convert visitors into users and users into contributors, thus increasing the adoption of the product.

...

  • Create a directory in the Apache Airflow repository to house the website

  • Determine the tool to be used to generate the website (Hugo, Jekyll, ..)

  • Create the knowledge architecture of the website

  • Create and receive approval for the design of the website

  • Create and receive approval for an initial prototype for the website

    • This prototype can be committed into the GitHub repository

  • Iterate to build an MVP

  • Move pages from Sphinx documentation to the new website

    • Team members, contributor’s guide, etc.

  • Build a set of tests for the website

  • Build a script to host and update the website

  • Change the website to the new landing page, and start receiving PRs from the community


Scope of Work

The project is starting on 8/26 and planned to be finished on 11/1.

Milestone 1: UX Design

  • Interactive prototype in InVision with the wireframes of the website (desktop version)
  • .png files of the wireframes for desktop, mobile, and tablet
    • The landing page including the site navigation menu
    • About, Documentation, Downloads, Community, Contribute, Resources (Case Studies, Videos, Tutorials)  pages
  • Brand book with updated logo (including logo safe space, colors, how not to use the logo and black&white version) - up to 7 pages, PDF

Acceptance criteria: 

  • The design of the website is accepted by Apache Airflow community and corresponds to all requirements of an open-source project design requirements. Should we not receive an acceptance or feedback from Apache Airflow community within 72 hours we will rely on Lazy Consensus rule. 

Milestone 2: User Testing & Evaluation

  • Key findings from the user testing in a presentation (PDF)
    • Including 3 male and 3 female users
  • Correcting the wireframes based on feedback from the community and user feedback
    • .png of the wireframes for desktop, mobile, and tablet

Acceptance criteria:

  • N/A

Milestone 3: UI Design

  • Exported mockups to Zeplin for desktop, mobile, and tablet
    • The landing page including the site navigation menu
    • About, Documentation, Downloads, Community, Contribute, Resources (Case Studies, Videos, Tutorials)  pages
    • Icons for feature descriptions
    • Updated prototype in inVision to share with the community

Acceptance criteria:

  • The prototype of the website is accepted by Apache Airflow community and corresponds to all requirements of an open-source project design requirements. Should we not receive an acceptance or feedback from Apache Airflow community within 72 hours we will rely on Lazy Consensus rule. 

Milestone 4: Website Development

  • The landing page including the site navigation menu according to the design 
  • Cut layout into HTML/CSS
  • Responsive web design
  • About, Documentation, Downloads, Community, Contribute, Resources (Case Studies, Videos, Tutorials)  pages according to the design
  • Developed static website with tools accepted by community
  • Bug fixes and improvements after review from Apache Airflow community
  • Documentation for Apache Airflow community to maintain the website in future

Acceptance criteria: 

  • Website developed using tools accepted by Airflow community 
  • Automatic content tests: spell checker and dead links checks
  • Automatic code tests e.g. check syntax/code style.
  • Documentation for making look and feel changes

Milestone 5: Documentation redesign, Sphinx integration, setup CI/CD

  • Implementation of custom Sphinx theme according to new design
  • Building script and integration with main site
  • Automatic deploy of changes for review
  • Establish and document a process for changes using pull requests
  • Precise documentation on maintenance of both content and operation of the website

Acceptance criteria: 

  • The documentation page is accepted by Apache Airflow community and corresponds to all requirements of an open-source project design requirements. Should we not receive an acceptance or feedback from Apache Airflow community within 72 hours we will rely on Lazy Consensus rule. 

Milestone 6: Finalizing feedback, bug-fixing and testing

  • Necessary UI adjustments to the final website version
  • Knowledge transfer and additional documentation such as README.md and dev/user docs

Acceptance criteria:

  • The complete website (static website and documentation) is accepted by the community

References

...

  • About

  • Documentation, which will link to the existing https://airflow.apache.org/ website.

  • Community

    • Airflow contributor Code of Conduct

    • Stack Overflow

    • Twitter

    • GitHub

    • Slack

    • Roadmap

    • Code of conduct

      • Airflow contributor Code of Conduct

    • Meetup schedules/events (cross-linked with homepage)

    • Mailing lists

    • Other communication channels

    • Stack Overflow

    • Twitter

    • GitHub

      • Slack

  • Blog

    • The blog will be edited via source control

    • Content from the Apache Airflow team

    • Articles from the community

...

    • Start contributing

      • Repositories

      • Prerequisites/Contributor checklist

  • Downloads / Releases (cross-linked with Homepage download)

    • Contributor recognition?

    • New version of the product

    • Features and improvements

      • Contributor recognition?

  • Site search - maybe

  • User is able to find content

    • Try to measure feasibility of Apache Airflow site searching capabilities

    • User is able to find content

Footer

  • Communication channels

  • Sitemap

...