subversion-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject svn commit: r900515 - in /subversion/site/publish: docs/ docs/index.html documentation.html site-nav.html
Date Mon, 18 Jan 2010 19:07:49 GMT
Author: cmpilato
Date: Mon Jan 18 19:07:49 2010
New Revision: 900515

Introduce heirarchy at the "Documentation" level, and leave so TODOs
with ideas about managing our docs.

* publish/documentation.html
  Move this...

* publish/docs,
* publish/docs/index.html here, with edits.

* publish/site-nav.html
  Update link to Documentation website area.

      - copied, changed from r900404, subversion/site/publish/documentation.html

Copied: subversion/site/publish/docs/index.html (from r900404, subversion/site/publish/documentation.html)
--- subversion/site/publish/documentation.html (original)
+++ subversion/site/publish/docs/index.html Mon Jan 18 19:07:49 2010
@@ -2,7 +2,7 @@
 <html xmlns="">
-<title>Apache Subversion</title>
+<title>Subversion Documentation</title>
 <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
 <style type="text/css" media="screen">
   @import url("/style/site.css");
@@ -14,15 +14,74 @@
 <!--#include virtual="/site-nav.html" -->
 <div id="site-content">
 <!--#include virtual="/site-notice.html" -->
+<!-- **************** BEGIN CONTENT ***************** -->
 <h1>Subversion Documentation</h1>
-<p>If you want to know how to use Subversion, you should look first in
-   the <a href="">Subversion book</a>.</p>
+<p>Subversion is fortunate to have a community that values
+   documentation.  This page contains pointers to varies sources of
+   documentation aimed at Subversion users and developers both of
+   Subversion and of third-party tools with which Subversion
+   integrates.  Much of this documentation is itself freely licensed,
+   so if you spot errors in them, please feel free to submit
+   corrections to the relevant owners of the documentation.</p>
-<p>If you are looking for documentation of the Subversion code, see the
-   <a href="/dev/api/">C API documentation</a>.</p>
+<div class="h2" id="user-manuals" title="user-manuals">
+<h2>Subversion User Manuals</h2>
+<p>If you want to know how to use Subversion, you can find a number of
+   published user manuals available
+   for <a href=""
+   >purchase</a> online.  One of these texts
+   &mdash; <span style="font-style: italic;" >Version Control With
+   Subversion</span> (affectionately known as "the Subversion book")
+   &mdash; carries a free license, was developed openly by the
+   Subversion community itself, and is also available in full online
+   for free at <a href=""
+   ></a>.</p>
+</div> <!-- #user-manuals -->
+<div class="h2" id="api" title="api">
+<h2>Subversion API</h2>
+<p>Subversion is a collection of modular libraries written in the C
+   programming language, each of which has a clearly defined
+   collection of functions and types that together make up
+   Subversion's application programming interface (API).  This API is
+   stable within major release streams of the software itself, so if
+   you write software that uses Subversion 1.1.0's interfaces, you
+   should expect that software to continue to work when linked against
+   Subversion 1.6.0 libraries without your having to change your
+   software at all.</p>
+<p>Here is Subversion's <a href="/dev/api/">C API
+   documentation</a>.</p>
+<p class="todo">Build out a table of links to the C and JavaHL APIs
+   over various release streams (1.6.x, 1.5.x, etc.), plus a link to
+   some nightly-generated trunk documentation (which is clearly
+   marked as unofficial, not-sanctioned-by-the-ASF, etc.)</p>
+</div> <!-- #api -->
+<div class="h2" id="guides" title="guides">
+<h2>Community Guides</h2>
+<p class="todo">Build out a list of links to useful
+   community-interaction guidelines: our mailing list policies, our
+   hacking document, our bug reporting policies, etc.  Consider
+   splitting hacking.html up into one subsection per HTML page, and
+   merging into it the likes of translating.html and
+   testing-goals.html.  Could we manage to combine <em>all</em> of
+   these into one <span style="font-style: italic;" >Subversion
+   Community Guide</span> document?</p>
+<!-- ***************** END CONTENT ****************** -->
 </div> <!-- #site-content -->

Modified: subversion/site/publish/site-nav.html
--- subversion/site/publish/site-nav.html (original)
+++ subversion/site/publish/site-nav.html Mon Jan 18 19:07:49 2010
@@ -4,7 +4,7 @@
   <li>About Subversion
       <li><a href="/#news">News</a></li>
-      <li><a href="/documentation.html">Documentation</a></li>
+      <li><a href="/docs/">Documentation</a></li>
       <li><a href="/faq.html">FAQ</a></li>
       <li><a href="/roadmap.html">Roadmap</a></li>

View raw message