Author: shinz
Date: 2006-12-15 18:15:24 +0100 (Fri, 15 Dec 2006)
New Revision: 4276
Log:
Add NOTES for things to remember
Added:
branches/refman-telcos/NOTES
Added: branches/refman-telcos/NOTES
===================================================================
--- branches/refman-telcos/NOTES (rev 0)
+++ branches/refman-telcos/NOTES 2006-12-15 17:15:24 UTC (rev 4276)
Changed blocks: 1, Lines Added: 49, Lines Deleted: 0; 1857 bytes
@@ -0,0 +1,49 @@
+Things to remember ...
+
+1. Jimmy on required formats
+----------------------------
+> Between the our various customers (and their customers) that will be
+> requiring access to the documentation, the following formats in English
+> will be required.
+>
+> - Downloadable Single Page HTML in tar.gz and .zip
+> - PDF (US Letter and A4)
+> - HTML online
+
+2. Stefan on directory layout
+-----------------------------
+I'd suggest to put everything (downloadable formats, online viewable
+formats) under this directory:
+
+http://dev.mysql.com/doc/refman/5.1-telco/
+
+That directory, and everything under it, should be accessible only
+after logging in. Note that this impacts search engines like Google,
+too (you won't be able to google for contents); I'll come to that later.
+
+We should have an overview page there, similar to the regular overview
+page (http://dev.mysql.com/doc/index.html) but, of course, much shorter:
+
+http://dev.mysql.com/doc/refman/5.1-telco/index.html
+
+That page should provide these links:
+
+- Online viewable version:
+ http://dev.mysql.com/doc/refman/5.1-telco/en/index.html
+
+- Downloadable versions:
+ - refman-5.1-telco-en.pdf
+ - refman-5.1-telco-en.a4.pdf
+ - refman-5.1-telco-en.html.tar.gz
+ - refman-5.1-telco-en.html.zip
+
+It's up to the web team to decide where to place those downloadable
+formats. Normally, docs downloads can be found here:
+
+ - http://downloads.mysql.com/docs/
+
+But that's obviously not a suitable location for the telco manual. I'd
+suggest to create this directory, accessible with the same login as
+mentioned above:
+
+ - http://downloads.mysql.com/docs-telco/
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r4276 - branches/refman-telcos | stefan | 15 Dec |
