Estimated Reading Time:

Podlings need to build a community in Apache in order to be accepted as part of the Apache Software Foundation. One of the tools used to build a community is the web site.

Podling Website Requirements

Podlings are, by definition, not yet fully accepted as part of the Apache Software Foundation. Therefore, they are subject to additional constraints on their websites. These policies MUST be adhered to before Graduation is considered unless prior approval is obtained from the Incubator PMC.

Creating the Podling Website

Creating A Good Podling Site

Apache Project Web Sites typically include several standard pages. Each page is formatted with a navigation bar on the left and a project standard header that includes the Incubator graphic.

The Web Site can be established during incubation, and migrated after incubation to a permanent place in the TLP home.

  • Project Home Page: the primary entry point to the site; contains project description, news, invitation to join the project.

  • License Page: link to the Apache License 2.0

  • Downloads: many projects in incubation will release code, and this page describes them and has links to the download pages that redirect to Apache Mirror sites.

  • Documentation: this page describes the project documentation, including javadoc for Java projects; guides, tutorials, and links to external documentation.

  • Committers: a list of current committers on the project.

  • Mailing Lists: there are several mailing lists that the community might be interested in, and this page contains mailto: links that allow easy subscription (and unsubscription) to any of them.

  • FAQ: frequently asked questions are answered here.

  • Source Code: links to the browsable source repository and git or svn commands to check out the sources.

  • Issue Tracking: links to the JIRA or other issue tracking tool, possibly including frequently used filters for issue lists.

  • Dependencies: other projects that this project depends on.

  • favicon: the project’s icon in a format suitable for a browser’s address bar. If absent, an Apache Feather will be displayed.

Web Site Generation Tool

The choice of tool used to generate the web site is left to the podling. If you already have a tool that you are comfortable with, you can continue to use it. If you do not, consider using the Jekyll based Apache website template.

Regardless of which tool you use, the web site should be maintained in the svn/git repository, and include the site generation tool. This simplifies the process of site generation and enables changes to the site to be made by any committer. The generated site should also be checked into svn/git.

Publishing Your Website

Managing a podling’s website is the same as a top-level project. Review the Infra Documentation on Project Websites

Using A Wiki To Create Documentation

Podlings may use a wiki to create documentation (including the website) providing that follow the guidelines.

Web Site Transition

Projects may arrive with existing web sites outside Apache. Contributing as much documentation as possible to the project from these sites is strongly encouraged. Offshore sites related to projects are fine but official web sites for Apache projects should be hosted by Apache.

Some projects elect to maintain previous releases outside Apache. In this case, the existing site is typically retained as a hub for this maintenance work. Otherwise, sites should link or redirect to the official Apache site.

Apache may accept donations of domains related to projects moving here. Infrastructure will then arrange for renewal of the domains and redirection of traffic the official site. Ask infrastructure for more details.

Apache needs to deal with all commercial entities equitably. Linking to useful information on commercial sites is fine but unfair discrimination between commercial sites is not. Most Apache projects find it better to simply link only to relevant articles on commercial sites rather than having to vet every request for links to commercial activity.