dave2wave commented on a change in pull request #81: URL: https://github.com/apache/incubator/pull/81#discussion_r548703824
########## File path: pages/guides/sites.ad ########## @@ -19,85 +19,80 @@ Apache Incubator PMC :imagesdir: ../images/ 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. +as part of the Apache Software Foundation. The podling website is one of the tools you use to build +that community. == 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. +constraints on their websites. You MUST adhere to these policies before we can consider the podling for +Graduation, unless you obtain prior approval from the Incubator PMC. - The published site for each podling must conform to the guidelines in link:/guides/branding.html[Podling Branding/Publicity]. -- Podlings should review link:https://www.apache.org/foundation/marks/linking[Corporate Recognition Best Practices], link:https://www.apache.org/foundation/marks/resources[Apache trademark information], and must aim to be in compliance with link:https://www.apache.org/foundation/marks/pmcs[Apache Project Website Branding Policy] -- The sources for every podling site sources should be maintained in the podling's site SVN or git directory +- Podlings should review link:https://www.apache.org/foundation/marks/linking[Corporate Recognition Best Practices], link:https://www.apache.org/foundation/marks/resources[Apache trademark information], and must aim to comply with the link:https://www.apache.org/foundation/marks/pmcs[Apache Project Website Branding Policy]. +- You should maintain the sources for the podling website in the podling's site SVN or Git directory. - The published site for each podling should conform to this URL space: #http://podlingname.incubator.apache.org/# or #http://podlingname.apache.org/# -- Every podling should maintain an incubation status file under: #http://incubator.apache.org/projects/podlingname.html# (this is generated) +- Every podling should maintain an incubation status file under: #http://incubator.apache.org/projects/podlingname.html# (this is generated). == Creating the Podling Website -=== Creating A Good Podling Site +=== 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 +Each page has 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. +You can establish the website during incubation, and migrate it +after incubation to a permanent place in the TLP (Top Level Project) 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. +- License Page: link to the Apache License 2.0. +- Downloads: many projects in incubation release code, and this page describes the releases and has links to the download pages that redirect to Apache Mirror sites. +- Documentation: this page presents the project documentation, including javadoc for Java projects, guides and 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. +- Mailing Lists: there are several mailing lists that the site visitors might be interested in, and this page contains `mailto:` links that allow easy subscription (and unsubscription) to any of them. +- FAQ: answers to frequently asked questions. +- Source Code: links to the browsable source repository and git or svn commands to check out the source code. +- 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. +- favicon: the project's icon in a format suitable for a browser's address bar. If the favicon is absent, an Apache Feather displays. -=== Web Site Generation Tool +=== Website 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 podling can choose the tool it wishes to use to generate the website. The Infrastructure team provides link:https://infra.apache.org/website-guidelines.html[guidance] concerning tools that work best with Apache's infrastructure, and what podlings and projects must avoid. If you already have a tool that you are comfortable +with, you can probably continue to use it. If you do not, consider using the Jekyll based link:https://github.com/apache/apache-website-template[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. +Regardless of which tool you use, maintain the web site in the podling's svn/git repository, and include instructions for using the site generation tool. +This simplifies the process of site generation and lets any podling committer make changes +to the siter. Check the generated site into svn/git. Review comment: to the site ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: general-unsubscr...@incubator.apache.org For additional commands, e-mail: general-h...@incubator.apache.org
