Skip to end of metadata
Go to start of metadata

<ac:macro ac:name="section"><ac:rich-text-body>
<ac:macro ac:name="column"><ac:parameter ac:name="width">50%</ac:parameter><ac:rich-text-body>

<h2>About</h2>
<ul>
<li>What is Zend Framework?</li>
<li>Is Zend Framework right for me?</li>
<li>Roadmap</li>
<li>Core contributors</li>
<li>Copyright and licensing</li>
</ul>

<h2>Documentation</h2>
<ul>
<li><h3>Zend Framework</h3>
<ul>
<li>Installation</li>
<li>Requirements</li>
<li>Configuration</li>
</ul>
</li>
<li><h3>Reference Manual</h3>
<ul>
<li><ac:link><ri:content-entity ri:content-id="4307" /><ac:link-body>Incubator documenation</ac:link-body></ac:link></li>
<li><ac:link><ri:content-entity ri:content-id="8151" /><ac:link-body>Brazilian Portuguese</ac:link-body></ac:link></li>
<li><ac:link><ri:content-entity ri:content-id="8050" /><ac:link-body>Dutch</ac:link-body></ac:link></li>
<li><ac:link><ri:content-entity ri:content-id="4309" /><ac:link-body>English</ac:link-body></ac:link></li>
<li><ac:link><ri:content-entity ri:content-id="8056" /><ac:link-body>French</ac:link-body></ac:link></li>
<li><ac:link><ri:content-entity ri:content-id="8052" /><ac:link-body>German</ac:link-body></ac:link></li>
<li><ac:link><ri:content-entity ri:content-id="8058" /><ac:link-body>Japanese</ac:link-body></ac:link></li>
<li><ac:link><ri:content-entity ri:content-id="8060" /><ac:link-body>Polish</ac:link-body></ac:link></li>
<li><ac:link><ri:content-entity ri:content-id="8153" /><ac:link-body>Russian</ac:link-body></ac:link></li>
<li><ac:link><ri:content-entity ri:content-id="8155" /><ac:link-body>Simplfied Chinese</ac:link-body></ac:link></li>
<li><ac:link><ri:content-entity ri:content-id="8054" /><ac:link-body>Spanish</ac:link-body></ac:link></li>
</ul>
</li>
<li>API Documentation (core)</li>
<li>API Documentation (incubator)</li>
<li><h3>External Documentation</h3>
<ul>
<li>Tutorials</li>
<li>Articles</li>
</ul>
</li>
<li><h3>Developer Documentation</h3>
<ul>
<li>Standards</li>
<li>Best practice+</li>
</ul>
</li>
</ul>

<h2>Miscellaneous</h2>
<ul>
<li>Developer Notes</li>
<li>Infrastructure</li>
<li>Community Sandbox Server</li>
<li>Requirements</li>
</ul>
</ac:rich-text-body></ac:macro>

<ac:macro ac:name="column"><ac:parameter ac:name="width">50%</ac:parameter><ac:rich-text-body>
<h2>Contributing</h2>
<ul>
<li>How can I contribute?</li>
<li>Mailing lists</li>
<li>The proposal process</li>
<li>The contributor license agreement</li>
<li>Coding standards</li>
<li>Subversion code repository</li>
<li>Issue tracker</li>
<li>Changeset browser</li>
<li><h3>Code Contributor Guide</h3>
<ul>
<li>Branching Model</li>
<li>Issue Tracker Etiquette</li>
<li>PHP Coding Standard (draft, ZF 0.2 RC1)</li>
<li>RSS Feeds and Notifications</li>
<li>Subversion Standards</li>
<li>Testing Standards</li>
<li>Proposal Process</li>
</ul>
</li>
</ul>

<ul>
<li><h3>Documentation Guide</h3>
<ul>
<li>Documentation Standard</li>
<li>DocBook and Right to Left Languages</li>
<li>Getting Started</li>
<li>Manual Compilation Instructions</li>
</ul>
</li>
</ul>

<h2>Project Teams</h2>
<ul>
<li><ac:link><ri:page ri:content-title="Auth Team" ri:space-key="ARCHIVE" /><ac:link-body>Auth Team</ac:link-body></ac:link></li>
<li><ac:link><ri:page ri:content-title="Core Infrastructure Team" ri:space-key="ARCHIVE" /><ac:link-body>Core Infrastructure Team</ac:link-body></ac:link></li>
<li><ac:link><ri:page ri:content-title="DB Team" ri:space-key="ARCHIVE" /><ac:link-body>DB Team</ac:link-body></ac:link></li>
<li><ac:link><ri:page ri:content-title="Documentation Team" ri:space-key="ZFDEV" /><ac:link-body>Documentation Team</ac:link-body></ac:link></li>
<li><ac:link><ri:page ri:content-title="i18n Locale Team" ri:space-key="ARCHIVE" /><ac:link-body>i18n Locale Team</ac:link-body></ac:link></li>
<li><ac:link><ri:page ri:content-title="MFS Team (Mail, Formats, Search)" ri:space-key="ARCHIVE" /><ac:link-body>MFS Team (Mail, Formats, Search)</ac:link-body></ac:link></li>
<li><ac:link><ri:page ri:content-title="MVC Team" ri:space-key="ARCHIVE" /><ac:link-body>MVC Team</ac:link-body></ac:link></li>
<li><ac:link><ri:page ri:content-title="Server Management Team" ri:space-key="ARCHIVE" /><ac:link-body>Server Management Team</ac:link-body></ac:link></li>
<li><ac:link><ri:page ri:content-title="Web Services Team" ri:space-key="ARCHIVE" /><ac:link-body>Web Services Team</ac:link-body></ac:link></li>
</ul>
</ac:rich-text-body></ac:macro></ac:rich-text-body></ac:macro>

Labels:
None
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.
  1. Sep 19, 2006

    <p>Ideas (sources for ideas in organizing a site map):</p>
    <ul>
    <li><a class="external-link" href="http://www.ralfeggert.de/zfw/sidebar.htm">http://www.ralfeggert.de/zfw/sidebar.htm</a></li>
    <li><a class="external-link" href="http://framework.zend.com/wiki/display/ZFUSER/Zend+Framework+Sidebar">http://framework.zend.com/wiki/display/ZFUSER/Zend+Framework+Sidebar</a></li>
    <li><a class="external-link" href="http://drupal.org/community">http://drupal.org/community</a> (their website organization makes it easy to find things)</li>
    </ul>

    <p><a href="http://framework.zend.com/wiki/display/ZFDEV/Documentation+Team#DocumentationTeam-UsingthisWikitoSupporttheTeamsHelpwanted">Volunteers Needed for creating site map and suggesting organizational improvements</a></p>

  2. Sep 20, 2006

    <p>There needs to be some standardization of the name of the manual. The navigation and URL say "manual," but the manual itself is titled "Programmer's Reference Guide." On the side menu it says "Zend Framework components" and also has links to the API documentation.</p>

    <p>I propose that the name is changed to "User manual" in all locations (except the navigation and URL, which should remain "manual").</p>

    <p>It could be composed of many of the items under "End-user documentation," structured as follows:</p>

    <ac:macro ac:name="noformat"><ac:plain-text-body><![CDATA[
    Zend Framework user manual

    1.0 Introduction
    1.1 System requirements
    1.2 Installation and configuration
    1.3 Best practices
    1.4 Tutorials
    2.0 Core components
    2.1 Zend
    2.2 Zend_Cache
    2.3 Etc.
    3.0 Other resources
    3.1 API documentation (core)
    3.2 API documentation (incubator)
    3.3 ?
    A. A.1 Copyright
    A.2 License
    ]]></ac:plain-text-body></ac:macro>

    <p>The introduction would include copyright information. I think the coding standards should be moved somewhere else, perhaps a separate contributor guide. The information on the proposal process, license agreement, Subversion repository, etc. is important and should be translated as well.</p>

    1. Nov 20, 2006

      <p>Currently, the Zend team uses the name "Zend Framework Reference Manual" to refer to the documentation contained in the DocBook XML files in SVN. The current wiki page above reflects substantial edits and improvements.</p>