Re: svn commit: r1817718 - /subversion/site/staging/docs/index.html / Reinstate 1.6 API docu

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
4 messages Options
Reply | Threaded
Open this post in threaded view
|

Re: svn commit: r1817718 - /subversion/site/staging/docs/index.html / Reinstate 1.6 API docu

Stefan
On 10/12/2017 16:54, [hidden email] wrote:

> Author: luke1410
> Date: Sun Dec 10 15:54:23 2017
> New Revision: 1817718
>
> URL: http://svn.apache.org/viewvc?rev=1817718&view=rev
> Log:
> * site/staging/docs/index.html: add a new section for unsupported versions and
>   move the 1.7 links to that section.
>
> Modified:
>     subversion/site/staging/docs/index.html
>
> Modified: subversion/site/staging/docs/index.html
> URL: http://svn.apache.org/viewvc/subversion/site/staging/docs/index.html?rev=1817718&r1=1817717&r2=1817718&view=diff
> ==============================================================================
> --- subversion/site/staging/docs/index.html (original)
> +++ subversion/site/staging/docs/index.html Sun Dec 10 15:54:23 2017
> @@ -135,19 +135,6 @@
>  
>  </div> <!-- #release-1.8 -->
>  
> -<div class="h3" id="release-1.7">
> -<h3>Subversion 1.7
> -<a class="sectionlink" href="#release-1.7"
> -    title="Link to this section">&para;</a>
> -</h3>
> -
> -<ul>
> -  <li><a href="api/1.7/">C API</a></li>
> -  <li><a href="javahl/1.7/">JavaHL</a></li>
> -</ul>
> -
> -</div> <!-- #release-1.7 -->
> -
>  <div class="h3" id="next-release">
>  <h3>Unreleased (1.10-dev)
>  <a class="sectionlink" href="#next-release"
> @@ -175,6 +162,23 @@
>  
>  </div> <!-- #latest-release -->
>  
> +<div id="release-1.7"></div>
> +<div class="h3" id="unsupported-releases">
> +<h3>Archived releses
> +  <a class="sectionlink" href="#unsupported-releases"
> +    title="Link to this section">&para;</a>
> +</h3>
> +
> +<p>The following Subversion versions have reached their end of life. We still
> +   provide the old documentation for archive/historical purposes.</p>
> +
> +<ul>
> +  <li><a href="api/1.7/">Subversion 1.7 - C API</a></li>
> +  <li><a href="javahl/1.7/">Subversion 1.7 - JavaHL</a></li>
> +</ul>
> +
> +</div> <!-- #unsupported-releases -->
> +
>  </div> <!-- #api -->
>  
>  </div> <!-- #site-content -->
>
Based on the discussion with brane on IRC, I'd like to propose this
change to our API documentation and in principle add a new
unsupported-releases section where upon each release we move the old API
documentation of the then unsupported oldest release to.

In addition, I'd like to reinstate the old 1.6 docu and add links to
these in this new section. The 1.6 docu was removed in r1696552 and now
results in old links to the 1.6 API docu no longer working (one example
being a link from the 1.6-release notes). Also I think it'd be quite
useful to keep the API documentation for unsupported versions still
laying around (it should not cause any significant resources keeping
them available, IMO).

Note that I'd reinstate the old 1.6 docus directly on publish (rather
than on staging) since this would be easier to do (i.e. reverting the
corresponding changes from r1696552 which obviously were done on publish).

Any objections and/or better ideas?

Regards,
Stefan

Reply | Threaded
Open this post in threaded view
|

Re: svn commit: r1817718 - /subversion/site/staging/docs/index.html / Reinstate 1.6 API docu

Stefan
On 10/12/2017 17:11, Branko ─îibej wrote:
On 10.12.2017 17:00, Stefan wrote:
On 10/12/2017 16:54, [hidden email] wrote:
Author: luke1410
Date: Sun Dec 10 15:54:23 2017
New Revision: 1817718

URL: http://svn.apache.org/viewvc?rev=1817718&view=rev
Log:
* site/staging/docs/index.html: add a new section for unsupported versions and
  move the 1.7 links to that section.

Modified:
    subversion/site/staging/docs/index.html

Modified: subversion/site/staging/docs/index.html
URL: http://svn.apache.org/viewvc/subversion/site/staging/docs/index.html?rev=1817718&r1=1817717&r2=1817718&view=diff
==============================================================================
--- subversion/site/staging/docs/index.html (original)
+++ subversion/site/staging/docs/index.html Sun Dec 10 15:54:23 2017
@@ -135,19 +135,6 @@
 
 </div> <!-- #release-1.8 -->
 
-<div class="h3" id="release-1.7">
-<h3>Subversion 1.7
-<a class="sectionlink" href="#release-1.7"
-    title="Link to this section">&para;</a>
-</h3>
-
-<ul>
-  <li><a href="api/1.7/">C API</a></li>
-  <li><a href="javahl/1.7/">JavaHL</a></li>
-</ul>
-
-</div> <!-- #release-1.7 -->
-
 <div class="h3" id="next-release">
 <h3>Unreleased (1.10-dev)
 <a class="sectionlink" href="#next-release"
@@ -175,6 +162,23 @@
 
 </div> <!-- #latest-release -->
 
+<div id="release-1.7"></div>
+<div class="h3" id="unsupported-releases">
+<h3>Archived releses
+  <a class="sectionlink" href="#unsupported-releases"
+    title="Link to this section">&para;</a>
+</h3>
+
+<p>The following Subversion versions have reached their end of life. We still
+   provide the old documentation for archive/historical purposes.</p>
+
+<ul>
+  <li><a href="api/1.7/">Subversion 1.7 - C API</a></li>
+  <li><a href="javahl/1.7/">Subversion 1.7 - JavaHL</a></li>
+</ul>
+
+</div> <!-- #unsupported-releases -->
+
 </div> <!-- #api -->
 
 </div> <!-- #site-content -->

Based on the discussion with brane on IRC, I'd like to propose this
change to our API documentation and in principle add a new
unsupported-releases section where upon each release we move the old API
documentation of the then unsupported oldest release to.

In addition, I'd like to reinstate the old 1.6 docu and add links to
these in this new section. The 1.6 docu was removed in r1696552 and now
results in old links to the 1.6 API docu no longer working (one example
being a link from the 1.6-release notes). Also I think it'd be quite
useful to keep the API documentation for unsupported versions still
laying around (it should not cause any significant resources keeping
them available, IMO).

Note that I'd reinstate the old 1.6 docus directly on publish (rather
than on staging) since this would be easier to do (i.e. reverting the
corresponding changes from r1696552 which obviously were done on publish).

Any objections and/or better ideas?


Go ahead, as long as it's perfectly clear that the older releases are no longer supported. Your change on the staging site looks OK, except that:
  • "Archived releses" is not English :p
  • I suggest "Unsupported versions" instead

Right. And corrected (with two successive commits) - it's "Unsupported versions" now.

Regards,
Stefan


Reply | Threaded
Open this post in threaded view
|

Re: svn commit: r1817718 - /subversion/site/staging/docs/index.html / Reinstate 1.6 API docu

Daniel Shahaf-2
In reply to this post by Stefan
Stefan wrote on Sun, 10 Dec 2017 17:00 +0100:
> Note that I'd reinstate the old 1.6 docus directly on publish (rather
> than on staging) since this would be easier to do (i.e. reverting the
> corresponding changes from r1696552 which obviously were done on publish).

Given that staging/ is a branch of publish/, it _should_ work to make
the revert on staging/ first.  It would be good dogfooding, too.  But as
always, he who does the legwork makes the calls.

> Any objections and/or better ideas?

I like the idea.

That said, a question.  svnbook has a problem where search engines offer
the 1.x book (for some x<8) as the first result.  Can we avoid this
problem happening for the doxygen docs?

IIRC there's an HTML tag that can be set to state "A newer version of
this doc is at <location/>", but I don't remember what it is, and I
realise it might not be straightforward to inject that tag into
generated docs.
Reply | Threaded
Open this post in threaded view
|

Re: svn commit: r1817718 - /subversion/site/staging/docs/index.html / Reinstate 1.6 API docu

Stefan
In reply to this post by Stefan
On 10/12/2017 17:23, Stefan wrote:
On 10/12/2017 17:11, Branko ─îibej wrote:
On 10.12.2017 17:00, Stefan wrote:
On 10/12/2017 16:54, [hidden email] wrote:
Author: luke1410
Date: Sun Dec 10 15:54:23 2017
New Revision: 1817718

URL: http://svn.apache.org/viewvc?rev=1817718&view=rev
Log:
* site/staging/docs/index.html: add a new section for unsupported versions and
  move the 1.7 links to that section.

Modified:
    subversion/site/staging/docs/index.html

Modified: subversion/site/staging/docs/index.html
URL: http://svn.apache.org/viewvc/subversion/site/staging/docs/index.html?rev=1817718&r1=1817717&r2=1817718&view=diff
==============================================================================
--- subversion/site/staging/docs/index.html (original)
+++ subversion/site/staging/docs/index.html Sun Dec 10 15:54:23 2017
@@ -135,19 +135,6 @@
 
 </div> <!-- #release-1.8 -->
 
-<div class="h3" id="release-1.7">
-<h3>Subversion 1.7
-<a class="sectionlink" href="#release-1.7"
-    title="Link to this section">&para;</a>
-</h3>
-
-<ul>
-  <li><a href="api/1.7/">C API</a></li>
-  <li><a href="javahl/1.7/">JavaHL</a></li>
-</ul>
-
-</div> <!-- #release-1.7 -->
-
 <div class="h3" id="next-release">
 <h3>Unreleased (1.10-dev)
 <a class="sectionlink" href="#next-release"
@@ -175,6 +162,23 @@
 
 </div> <!-- #latest-release -->
 
+<div id="release-1.7"></div>
+<div class="h3" id="unsupported-releases">
+<h3>Archived releses
+  <a class="sectionlink" href="#unsupported-releases"
+    title="Link to this section">&para;</a>
+</h3>
+
+<p>The following Subversion versions have reached their end of life. We still
+   provide the old documentation for archive/historical purposes.</p>
+
+<ul>
+  <li><a href="api/1.7/">Subversion 1.7 - C API</a></li>
+  <li><a href="javahl/1.7/">Subversion 1.7 - JavaHL</a></li>
+</ul>
+
+</div> <!-- #unsupported-releases -->
+
 </div> <!-- #api -->
 
 </div> <!-- #site-content -->

Based on the discussion with brane on IRC, I'd like to propose this
change to our API documentation and in principle add a new
unsupported-releases section where upon each release we move the old API
documentation of the then unsupported oldest release to.

In addition, I'd like to reinstate the old 1.6 docu and add links to
these in this new section. The 1.6 docu was removed in r1696552 and now
results in old links to the 1.6 API docu no longer working (one example
being a link from the 1.6-release notes). Also I think it'd be quite
useful to keep the API documentation for unsupported versions still
laying around (it should not cause any significant resources keeping
them available, IMO).

Note that I'd reinstate the old 1.6 docus directly on publish (rather
than on staging) since this would be easier to do (i.e. reverting the
corresponding changes from r1696552 which obviously were done on publish).

Any objections and/or better ideas?


Go ahead, as long as it's perfectly clear that the older releases are no longer supported. Your change on the staging site looks OK, except that:
  • "Archived releses" is not English :p
  • I suggest "Unsupported versions" instead

Right. And corrected (with two successive commits) - it's "Unsupported versions" now.

Regards,
Stefan


1.6 docu restored in r1818079 and linked in r1818081.

Regards,
Stefan