This repository was archived by the owner on Aug 20, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdocument.html
More file actions
767 lines (739 loc) · 34.7 KB
/
document.html
File metadata and controls
767 lines (739 loc) · 34.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
<!DOCTYPE html>
<!--
Generated by Apache Maven Doxia at 2015-12-08
Rendered using Reflow Maven Skin 1.1.1 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<title>Apache Trafodion Modify Documentation</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="description" content="" />
<meta http-equiv="content-language" content="en" />
<link href="http://netdna.bootstrapcdn.com/bootswatch/2.3.2/cerulean/bootstrap.min.css" rel="stylesheet" />
<link href="http://netdna.bootstrapcdn.com/twitter-bootstrap/2.3.1/css/bootstrap-responsive.min.css" rel="stylesheet" />
<link href="./css/bootswatch.css" rel="stylesheet" />
<link href="./css/reflow-skin.css" rel="stylesheet" />
<link href="http://yandex.st/highlightjs/7.5/styles/default.min.css" rel="stylesheet" />
<link href="./css/lightbox.css" rel="stylesheet" />
<link href="./css/site.css" rel="stylesheet" />
<link href="./css/print.css" rel="stylesheet" media="print" />
<!-- Le HTML5 shim, for IE6-8 support of HTML5 elements -->
<!--[if lt IE 9]>
<script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
</head>
<body class="page-document project-trafodion" data-spy="scroll" data-offset="60" data-target="#toc-scroll-target">
<div class="navbar navbar-fixed-top">
<div class="navbar-inner">
<div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target="#top-nav-collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</a>
<a class="brand" href="index.html">Apache <span class="color-highlight">Trafodion</span></a>
<div class="nav-collapse collapse" id="top-nav-collapse">
<ul class="nav pull-right">
<li ><a href="download.html" title="Download">Download</a></li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">About <b class="caret"></b></a>
<ul class="dropdown-menu">
<li ><a href="index.html" title="Project Overview">Project Overview</a></li>
<li ><a href="new-features.html" title="New Features">New Features</a></li>
<li ><a href="roadmap.html" title="Roadmap">Roadmap</a></li>
<li ><a href="performance.html" title="Performance">Performance</a></li>
<li ><a href="http:divider" title=""></a></li>
<li ><a href="team-list.html" title="Team">Team</a></li>
<li ><a href="presentations.html" title="Presentations">Presentations</a></li>
<li ><a href="mail-lists.html" title="Mailing List">Mailing List</a></li>
<li ><a href="http:divider" title=""></a></li>
<li ><a href="source-repository.html" title="Source Repository">Source Repository</a></li>
<li ><a href="issue-tracking.html" title="Issue Tracking">Issue Tracking</a></li>
<li ><a href="license.html" title="License">License</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Using <b class="caret"></b></a>
<ul class="dropdown-menu">
<li ><a href="quickstart.html" title="Quick Start">Quick Start</a></li>
<li ><a href="download.html" title="Download">Download</a></li>
<li ><a href="install.html" title="Install">Install</a></li>
<li ><a href="management.html" title="Managing Trafodion">Managing Trafodion</a></li>
<li ><a href="http:divider" title=""></a></li>
<li ><a href="documentation.html" title="Documentation">Documentation</a></li>
<li ><a href="faq.html" title="FAQ">FAQ</a></li>
<li ><a href="release-notes.html" title="Release Notes">Release Notes</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Features <b class="caret"></b></a>
<ul class="dropdown-menu">
<li ><a href="architecture-overview.html" title="Architecture Overview">Architecture Overview</a></li>
<li ><a href="http:divider" title=""></a></li>
<li ><a href="https://blueprints.launchpad.net/trafodion/+spec/security-ansi-schemas" title="ANSI Schema Support" class="externalLink">ANSI Schema Support</a></li>
<li ><a href="https://blueprints.launchpad.net/trafodion/+spec/ustat-automation" title="Automated Update Statistics" class="externalLink">Automated Update Statistics</a></li>
<li ><a href="https://blueprints.launchpad.net/trafodion/+spec/bulkunload" title="Bulk Unload" class="externalLink">Bulk Unload</a></li>
<li ><a href="https://wiki.trafodion.org/wiki/index.php/Trafodion_Manageability#Logging_Events" title="Event Handling" class="externalLink">Event Handling</a></li>
<li ><a href="https://blueprints.launchpad.net/trafodion/+spec/hybrid-query-cache" title="Hybrid Query Cache" class="externalLink">Hybrid Query Cache</a></li>
<li ><a href="https://blueprints.launchpad.net/trafodion/+spec/identity-column" title="Identity Column" class="externalLink">Identity Column</a></li>
<li ><a href="https://wiki.trafodion.org/wiki/index.php/Creating_Statistics_During_Bulk_Load" title="Immediate Update Statistics" class="externalLink">Immediate Update Statistics</a></li>
<li ><a href="https://blueprints.launchpad.net/trafodion/+spec/lob-support" title="Large Object (LOB)" class="externalLink">Large Object (LOB)</a></li>
<li ><a href="https://blueprints.launchpad.net/trafodion/+spec/ddl-query-invalidation" title="Metadata Query Invalidation" class="externalLink">Metadata Query Invalidation</a></li>
<li ><a href="https://cwiki.apache.org/confluence/display/TRAFODION/Cmp-divisioning" title="Multi-Temperature Data" class="externalLink">Multi-Temperature Data</a></li>
<li ><a href="https://blueprints.launchpad.net/trafodion/+spec/access-external-hbase-tables" title="Native HBase Tables" class="externalLink">Native HBase Tables</a></li>
<li ><a href="docs/Trafodion_odb_User_Guide.pdf" title="ODB">ODB</a></li>
<li ><a href="https://blueprints.launchpad.net/trafodion/+spec/sql-query-cancel" title="Query Cancel" class="externalLink">Query Cancel</a></li>
<li ><a href="https://blueprints.launchpad.net/trafodion/+spec/security-privilege-updates" title="Privilege Checking" class="externalLink">Privilege Checking</a></li>
<li ><a href="https://wiki.trafodion.org/wiki/index.php/Trafodion_Manageability" title="Repository" class="externalLink">Repository</a></li>
<li ><a href="https://blueprints.launchpad.net/trafodion/+spec/enable-get-statistics-thru-rms" title="Runtime Management System" class="externalLink">Runtime Management System</a></li>
<li ><a href="https://blueprints.launchpad.net/trafodion/+spec/sequence-numbers" title="Sequence Numbers" class="externalLink">Sequence Numbers</a></li>
<li ><a href="https://blueprints.launchpad.net/trafodion/+spec/skew-buster" title="Skew Buster" class="externalLink">Skew Buster</a></li>
<li ><a href="https://wiki.trafodion.org/wiki/index.php/Tutorial:_The_object-oriented_UDF_interface" title="Table-Oriented UDF" class="externalLink">Table-Oriented UDF</a></li>
<li ><a href="https://wiki.trafodion.org/wiki/index.php/Data_Loading#Trickle_Loading_Data_Into_Trafodion_Tables" title="Trickle Load" class="externalLink">Trickle Load</a></li>
<li ><a href="http:divider" title=""></a></li>
<li ><a href="https://wiki.trafodion.org/wiki/index.php/Backup_and_Restore" title="Backup/Restore Utility" class="externalLink">Backup/Restore Utility</a></li>
<li ><a href="https://wiki.trafodion.org/wiki/index.php/Metadata_Cleanup" title="Metadata Cleanup Utility" class="externalLink">Metadata Cleanup Utility</a></li>
</ul>
</li>
<li class="dropdown active">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Contributing <b class="caret"></b></a>
<ul class="dropdown-menu">
<li ><a href="contribute.html" title="Contribute">Contribute</a></li>
<li ><a href="advocate.html" title="Advocate">Advocate</a></li>
<li ><a href="develop.html" title="Develop">Develop</a></li>
<li ><a href="testing.html" title="Test">Test</a></li>
<li ><a href="merge.html" title="Merge">Merge</a></li>
<li ><a href="release.html" title="Release">Release</a></li>
<li ><a href="http:divider" title=""></a></li>
<li ><a href="create-dev-environment.html" title="Create Dev Environment">Create Dev Environment</a></li>
<li ><a href="manage-dev-environment.html" title="Manage Dev Environment">Manage Dev Environment</a></li>
<li ><a href="setup-build-environment.html" title="Setup Build Environment">Setup Build Environment</a></li>
<li ><a href="build.html" title="Build Trafodion">Build Trafodion</a></li>
<li ><a href="http:divider" title=""></a></li>
<li ><a href="code.html" title="Modify Code">Modify Code</a></li>
<li ><a href="tests.html" title="Modify Tests">Modify Tests</a></li>
<li class="active"><a href="" title="Modify Documentation">Modify Documentation</a></li>
<li ><a href="website.html" title="Modify Web Site">Modify Web Site</a></li>
<li ><a href="wiki.html" title="Modify Wiki Pages">Modify Wiki Pages</a></li>
<li ><a href="http:divider" title=""></a></li>
<li ><a href="cplusplus-coding-guidelines.html" title="C++ Coding Guidelines">C++ Coding Guidelines</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Apache <b class="caret"></b></a>
<ul class="dropdown-menu">
<li ><a href="http://incubator.apache.org/projects/trafodion.html" title="Status Page" target="_blank" class="externalLink">Status Page</a></li>
<li ><a href="http://www.apache.org/foundation/how-it-works.html" title="Apache Foundation" target="_blank" class="externalLink">Apache Foundation</a></li>
<li ><a href="http://www.apache.org/licenses/" title="Apache License" target="_blank" class="externalLink">Apache License</a></li>
<li ><a href="http://www.apache.org/security/" title="Apache Security" target="_blank" class="externalLink">Apache Security</a></li>
<li ><a href="http:divider" title=""></a></li>
<li ><a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsorship" target="_blank" class="externalLink">Sponsorship</a></li>
<li ><a href="http://www.apache.org/foundation/thanks.html" title="Thanks" target="_blank" class="externalLink">Thanks</a></li>
</ul>
</li>
</ul>
</div><!--/.nav-collapse -->
</div>
</div>
</div>
<div class="container">
<!-- Masthead
================================================== -->
<header>
<div class="jumbotron subhead">
<div class="row" id="banner">
<div class="span12">
<div class="pull-left">
<a href="index.html" id="bannerLeft"><h1>Apache <span class="color-highlight">Trafodion</span></h1></a>
<p class="lead">Transactional SQL-on-Hadoop Database</p>
</div>
<div class="pull-right">
</div>
</div>
</div>
</div>
<div>
<ul class="breadcrumb">
<li><a href="index.html" title="Trafodion">Trafodion</a></li>
<li class="divider">/</li>
<li>Modify Documentation</li>
</ul>
</div>
<hr class="toc-separator" />
<div id="toc-bar" class="navbar" data-spy="affix" data-offset-top="250">
<div class="navbar-inner">
<div id="toc-scroll-target" class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target="#toc-nav-collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</a>
<div class="nav-collapse collapse" id="toc-nav-collapse">
<ul id="toc" class="nav">
<li class="dropdown">
<a href="#organization" title="Organization" class="dropdown-toggle" role="button" data-toggle="dropdown" data-target="#">Organization <b class="caret"></b></a>
<ul class="dropdown-menu" role="menu">
<!-- Repeat the item, otherwise it is not clickable as the dropdown root -->
<li><a href="#organization" title="Organization">Organization</a></li>
<li class="divider"></li>
<li><a href="#Source" title="Source">Source</a></li>
<li><a href="#Web" title="Web">Web</a></li>
</ul>
</li>
<li class="divider-vertical"></li>
<li class="dropdown">
<a href="#making_changes" title="Making Changes" class="dropdown-toggle" role="button" data-toggle="dropdown" data-target="#">Making Changes <b class="caret"></b></a>
<ul class="dropdown-menu" role="menu">
<!-- Repeat the item, otherwise it is not clickable as the dropdown root -->
<li><a href="#making_changes" title="Making Changes">Making Changes</a></li>
<li class="divider"></li>
<li><a href="#Word_Documents" title="Word Documents">Word Documents</a></li>
<li><a href="#Asciidoc_Documents" title="Asciidoc Documents">Asciidoc Documents</a></li>
</ul>
</li>
<li class="divider-vertical"></li>
<li class="toplevel"><a href="#publishing" title="Publishing">Publishing</a></li>
</ul>
</div>
</div>
</div>
</div>
</header>
<div class="main-body">
<div class="row">
<div class="span12">
<div class="body-content">
<!-- Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the
License. -->
<p>This page describes how to modify the Trafodion documentation. Please refer to the <a href="contribute.html">Contribute</a> page for information about other ways to contribute to the Trafodion project.</p>
<div class="page-header">
<h1 id="organization">Organization</h1>
</div>
<p>Documents do <b>not</b> include version information as part of the file name.</p>
<div class="section">
<h2 id="Source">Source</h2>
<table border="0" class="bodyTable table table-striped table-hover">
<thead>
<tr class="a">
<th>Document </th>
<th>Source Format </th>
<th>Source Tree </th>
<th>Output Format</th>
</tr>
</thead>
<tbody>
<tr class="b">
<td>Client Installation Guide </td>
<td>word </td>
<td>External (Word) </td>
<td>PDF</td>
</tr>
<tr class="a">
<td>Command Interface Guide </td>
<td>word </td>
<td>External (Word) </td>
<td>PDF</td>
</tr>
<tr class="b">
<td>DCS Reference Guide </td>
<td>asciidoc </td>
<td><tt>dcs/src/main/asciidoc</tt> </td>
<td>Web Book, PDF</td>
</tr>
<tr class="a">
<td>DCS APIs </td>
<td>javadoc </td>
<td><tt>dcs/src/main/java</tt> </td>
<td>Web Book</td>
</tr>
<tr class="b">
<td>odb User Guide </td>
<td>word </td>
<td>External (Word) </td>
<td>PDF</td>
</tr>
<tr class="a">
<td>REST Reference Guide </td>
<td>asciidoc </td>
<td><tt>core/rest/src/main/asciidoc</tt> </td>
<td>Web Book, PDF</td>
</tr>
<tr class="b">
<td>REST APIs </td>
<td>javadoc </td>
<td><tt>core/rest/src/main/java</tt> </td>
<td>Web Book</td>
</tr>
<tr class="a">
<td>SQL Reference Manual </td>
<td>word </td>
<td>External (Word) </td>
<td>PDF</td>
</tr>
</tbody>
</table>
</div>
<div class="section">
<h2 id="Web">Web</h2>
<p><b><tt>docs/target/docs</tt></b> contains the <b>latest</b> version of the document. This practice makes it possible to link to a document in instructional text.</p>
<p>In addition, the documentation is copied to the <b><tt>docs/target/docs</tt></b> directory on a per-release basis. This directory is referred to as the <b>release document directory</b> below.</p>
<p><b>Example</b></p>
<table border="0" class="bodyTable table table-striped table-hover">
<thead>
<tr class="a">
<th>Release Document Directory </th>
<th>Content </th>
<th>Web Site Directory</th>
</tr>
</thead>
<tbody>
<tr class="b">
<td><b><tt>docs/target/1.3.0</tt></b> </td>
<td>Documentation related to the 1.3.0 release. </td>
<td><b><tt>incubator.trafodion.apache.org/docs/1.3.0</tt></b></td>
</tr>
<tr class="a">
<td><b><tt>docs/target/1.5.0</tt></b> </td>
<td>Documentation related to the 1.5.0 release. </td>
<td><b><tt>incubator.trafodion.apache.org/docs/1.5.0</tt></b></td>
</tr>
</tbody>
</table>
<p>The <b>release document directory</b> contains a sub-directory per document. The naming convention for these directories is the document name in all lower case without the manual/guide qualifier and with words separated by underscore. Web-based API definitions generated by <b><tt>javadoc</tt></b> are located under each sub-directory, if applicable.</p>
<p><b>Example</b></p>
<table border="0" class="bodyTable table table-striped table-hover">
<thead>
<tr class="a">
<th>Document </th>
<th>Sub Directory Name</th>
</tr>
</thead>
<tbody>
<tr class="b">
<td>Client Installation Guide </td>
<td><b><tt>client_installation</tt></b></td>
</tr>
<tr class="a">
<td>Command Interface Guide </td>
<td><b><tt>command_interface</tt></b></td>
</tr>
<tr class="b">
<td>DCS Reference Guide </td>
<td><b><tt>dcs_reference</tt></b></td>
</tr>
<tr class="a">
<td>odb User Guide </td>
<td><b><tt>odb_user</tt></b></td>
</tr>
<tr class="b">
<td>REST Reference Guide </td>
<td><b><tt>rest_reference</tt></b></td>
</tr>
<tr class="a">
<td>SQL Reference Manual </td>
<td><b><tt>sql_reference</tt></b></td>
</tr>
</tbody>
</table>
<p>The sub-directory is organized as follows. More files may be present in the sub-directory depending on document. </p>
<table border="0" class="bodyTable table table-striped table-hover">
<thead>
<tr class="a">
<th>File/Directory </th>
<th>Content</th>
</tr>
</thead>
<tbody>
<tr class="b">
<td><b><tt>*.pdf</tt></b> </td>
<td>The PDF version of the document. For example, <b><tt>Trafodion_SQL_Reference_Guide.pdf</tt></b>.</td>
</tr>
<tr class="a">
<td><b><tt>index.html</tt></b> </td>
<td>Entry point for the web book. Generated by asciidoc.</td>
</tr>
<tr class="b">
<td><b><tt>_chapters</tt></b> </td>
<td>Web book chapters; that is, the actual content.</td>
</tr>
<tr class="a">
<td><b><tt>apidocs</tt></b> </td>
<td>API documentation provided as web. Generated by javadoc.</td>
</tr>
<tr class="b">
<td><b><tt>apidocs/index.html</tt></b> </td>
<td>Entry point for API documentation.</td>
</tr>
<tr class="a">
<td><b><tt>css</tt></b> </td>
<td>CSS definitions used by the web-version of the document.</td>
</tr>
<tr class="b">
<td><b><tt>images</tt></b> </td>
<td>Images used by the web-version of the document.</td>
</tr>
</tbody>
</table>
<h1 id="making_changes">Making Changes</h1>
</div>
<div class="section">
<h2 id="Word_Documents">Word Documents</h2>
<p>Do the following:</p>
<ol style="list-style-type: decimal">
<li>Edit the document.</li>
<li>Save a PDF version.</li>
<li>Build the web site using <b><tt>mvn clean site</tt></b> against the <b><tt>docs</tt></b> directory.</li>
<li>Create the <b>Release Document Directory</b>, if needed.</li>
<li>Copy the PDF files to the <b>Release Document Directory</b>.</li>
<li>Copy and overwrite the PDF to the <b><tt>docs/target/docs</tt></b> directory — latest version of the document.</li>
</ol>
</div>
<div class="section">
<h2 id="Asciidoc_Documents">Asciidoc Documents</h2>
<p>Please refer to DCS <a class="externalLink" href="https://github.com/apache/incubator-trafodion/blob/master/dcs/src/main/asciidoc/_chapters/appendix_contributing_to_documentation.adoc">Contributing to Documentation</a> guidance for information about working on asciidoc-based documentation.</p>
<p>Once you’ve made the desired changes, then do the following:</p>
<ol style="list-style-type: decimal">
<li>Build the document using <b><tt>mvn clean site</tt></b> against the directory containing the document; for example: <b><tt>dcs</tt></b> or <b>```core/rest’’’</b>.</li>
<li>Verify the content in the generated <b><tt>target</tt></b> directory. The <b><tt>target/index.html</tt></b> file provides the entry point for the web book; the <b><tt>target/apidocs/index.html</tt></b> file contains the entry point for API documentation.</li>
</ol>
<p>You will need to move the files to the final <b>Release Document Directory</b>; refer to <a href="#Publishing">Publishing</a> below.</p>
<h1 id="publishing">Publishing</h1>
<div class="alert alert-dismissible alert-info">
<button type="button" class="close" data-dismiss="alert"></button>
<p style="color:black">Publication is done when a committer is ready to update the external web site. You do <b>not</b> perform these steps as part of checking in changes.</p>
</div>
<p><b>Prerequisite:</b> You need to build the web site before using these instructions. Please refer to <a href="website.html">Modifying Web Site</a>.</p>
<p>You will need to copy/move the documentation from its generated location to the <b>Release Document Directory</b>.</p>
<ol style="list-style-type: decimal">
<li>Create the <b>Release Document Directory</b> under <b><tt>docs/target/docs</tt></b> if it doesn’t already exist.</li>
<li>Copy the generated document files as follows:</li>
</ol>
<table border="0" class="bodyTable table table-striped table-hover">
<thead>
<tr class="a">
<th>Document </th>
<th>Populate Release Document Directory</th>
</tr>
</thead>
<tbody>
<tr class="b">
<td>Client Installation Guide </td>
<td>Copy the <b><tt>.pdf</tt></b> file to <b><tt>docs/target/docs</tt></b> and <b>Release Document Directory</b>.</td>
</tr>
<tr class="a">
<td>Command Interface Guide </td>
<td>Copy the <b><tt>.pdf</tt></b> file to <b><tt>docs/target/docs</tt></b> and <b>Release Document Directory</b>.</td>
</tr>
<tr class="b">
<td>DCS Reference Guide </td>
<td>Copy <b><tt>dcs/target/site/</tt></b> to the <b>Release Document Directory</b>.</td>
</tr>
<tr class="a">
<td>odb User Guide </td>
<td>Copy the <b><tt>.pdf</tt></b> file to <b><tt>docs/target/docs</tt></b> and <b>Release Document Directory</b>.</td>
</tr>
<tr class="b">
<td>REST Reference Guide </td>
<td>Copy <b><tt>core/rest/target/site/</tt></b> to the <b>Release Document Directory</b>.</td>
</tr>
<tr class="a">
<td>SQL Reference Manual </td>
<td>Copy the <b><tt>.pdf</tt></b> file to <b><tt>docs/target/docs</tt></b> and <b>Release Document Directory</b>.</td>
</tr>
</tbody>
</table>
<p><b>Example — Publishing the DCS Reference Guide</b></p>
<div class="source">
<div class="source">
<pre>cd $SQ_HOME/docs/target/docs
mkdir 1.3.0
cd 1.3.0
mkdir dcs_reference
cp -r $SQ_HOME/dcs/target/site/ .
</pre>
</div>
</div>
<p>Once the update of the <b>Release Document Directory</b> is complete, then you can complete the <a href="website.html#Publishing">web-site publication</a>.</p>
</div>
</div>
</div>
</div>
</div>
</div><!-- /container -->
<!-- Footer
================================================== -->
<footer class="well">
<div class="container">
<div class="row">
<div class="span2 bottom-nav">
<ul class="nav nav-list">
<li class="nav-header">About</li>
<li >
<a href="index.html" title="Project Overview">Project Overview</a>
</li>
<li >
<a href="new-features.html" title="New Features">New Features</a>
</li>
<li >
<a href="roadmap.html" title="Roadmap">Roadmap</a>
</li>
<li >
<a href="performance.html" title="Performance">Performance</a>
</li>
<li >
<a href="http:divider" title=""></a>
</li>
<li >
<a href="team-list.html" title="Team">Team</a>
</li>
<li >
<a href="presentations.html" title="Presentations">Presentations</a>
</li>
<li >
<a href="mail-lists.html" title="Mailing List">Mailing List</a>
</li>
<li >
<a href="http:divider" title=""></a>
</li>
<li >
<a href="source-repository.html" title="Source Repository">Source Repository</a>
</li>
<li >
<a href="issue-tracking.html" title="Issue Tracking">Issue Tracking</a>
</li>
<li >
<a href="license.html" title="License">License</a>
</li>
</ul>
</div>
<div class="span2 bottom-nav">
<ul class="nav nav-list">
<li class="nav-header">Using</li>
<li >
<a href="quickstart.html" title="Quick Start">Quick Start</a>
</li>
<li >
<a href="download.html" title="Download">Download</a>
</li>
<li >
<a href="install.html" title="Install">Install</a>
</li>
<li >
<a href="management.html" title="Managing Trafodion">Managing Trafodion</a>
</li>
<li >
<a href="http:divider" title=""></a>
</li>
<li >
<a href="documentation.html" title="Documentation">Documentation</a>
</li>
<li >
<a href="faq.html" title="FAQ">FAQ</a>
</li>
<li >
<a href="release-notes.html" title="Release Notes">Release Notes</a>
</li>
</ul>
</div>
<div class="span2 bottom-nav">
<ul class="nav nav-list">
<li class="nav-header">Features</li>
<li >
<a href="architecture-overview.html" title="Architecture Overview">Architecture Overview</a>
</li>
<li >
<a href="http:divider" title=""></a>
</li>
<li >
<a href="https://blueprints.launchpad.net/trafodion/+spec/security-ansi-schemas" title="ANSI Schema Support" class="externalLink">ANSI Schema Support</a>
</li>
<li >
<a href="https://blueprints.launchpad.net/trafodion/+spec/ustat-automation" title="Automated Update Statistics" class="externalLink">Automated Update Statistics</a>
</li>
<li >
<a href="https://blueprints.launchpad.net/trafodion/+spec/bulkunload" title="Bulk Unload" class="externalLink">Bulk Unload</a>
</li>
<li >
<a href="https://wiki.trafodion.org/wiki/index.php/Trafodion_Manageability#Logging_Events" title="Event Handling" class="externalLink">Event Handling</a>
</li>
<li >
<a href="https://blueprints.launchpad.net/trafodion/+spec/hybrid-query-cache" title="Hybrid Query Cache" class="externalLink">Hybrid Query Cache</a>
</li>
<li >
<a href="https://blueprints.launchpad.net/trafodion/+spec/identity-column" title="Identity Column" class="externalLink">Identity Column</a>
</li>
<li >
<a href="https://wiki.trafodion.org/wiki/index.php/Creating_Statistics_During_Bulk_Load" title="Immediate Update Statistics" class="externalLink">Immediate Update Statistics</a>
</li>
<li >
<a href="https://blueprints.launchpad.net/trafodion/+spec/lob-support" title="Large Object (LOB)" class="externalLink">Large Object (LOB)</a>
</li>
<li >
<a href="https://blueprints.launchpad.net/trafodion/+spec/ddl-query-invalidation" title="Metadata Query Invalidation" class="externalLink">Metadata Query Invalidation</a>
</li>
<li >
<a href="https://cwiki.apache.org/confluence/display/TRAFODION/Cmp-divisioning" title="Multi-Temperature Data" class="externalLink">Multi-Temperature Data</a>
</li>
<li >
<a href="https://blueprints.launchpad.net/trafodion/+spec/access-external-hbase-tables" title="Native HBase Tables" class="externalLink">Native HBase Tables</a>
</li>
<li >
<a href="docs/Trafodion_odb_User_Guide.pdf" title="ODB">ODB</a>
</li>
<li >
<a href="https://blueprints.launchpad.net/trafodion/+spec/sql-query-cancel" title="Query Cancel" class="externalLink">Query Cancel</a>
</li>
<li >
<a href="https://blueprints.launchpad.net/trafodion/+spec/security-privilege-updates" title="Privilege Checking" class="externalLink">Privilege Checking</a>
</li>
<li >
<a href="https://wiki.trafodion.org/wiki/index.php/Trafodion_Manageability" title="Repository" class="externalLink">Repository</a>
</li>
<li >
<a href="https://blueprints.launchpad.net/trafodion/+spec/enable-get-statistics-thru-rms" title="Runtime Management System" class="externalLink">Runtime Management System</a>
</li>
<li >
<a href="https://blueprints.launchpad.net/trafodion/+spec/sequence-numbers" title="Sequence Numbers" class="externalLink">Sequence Numbers</a>
</li>
<li >
<a href="https://blueprints.launchpad.net/trafodion/+spec/skew-buster" title="Skew Buster" class="externalLink">Skew Buster</a>
</li>
<li >
<a href="https://wiki.trafodion.org/wiki/index.php/Tutorial:_The_object-oriented_UDF_interface" title="Table-Oriented UDF" class="externalLink">Table-Oriented UDF</a>
</li>
<li >
<a href="https://wiki.trafodion.org/wiki/index.php/Data_Loading#Trickle_Loading_Data_Into_Trafodion_Tables" title="Trickle Load" class="externalLink">Trickle Load</a>
</li>
<li >
<a href="http:divider" title=""></a>
</li>
<li >
<a href="https://wiki.trafodion.org/wiki/index.php/Backup_and_Restore" title="Backup/Restore Utility" class="externalLink">Backup/Restore Utility</a>
</li>
<li >
<a href="https://wiki.trafodion.org/wiki/index.php/Metadata_Cleanup" title="Metadata Cleanup Utility" class="externalLink">Metadata Cleanup Utility</a>
</li>
</ul>
</div>
<div class="span2 bottom-nav">
<ul class="nav nav-list">
<li class="nav-header">Contributing</li>
<li >
<a href="contribute.html" title="Contribute">Contribute</a>
</li>
<li >
<a href="advocate.html" title="Advocate">Advocate</a>
</li>
<li >
<a href="develop.html" title="Develop">Develop</a>
</li>
<li >
<a href="testing.html" title="Test">Test</a>
</li>
<li >
<a href="merge.html" title="Merge">Merge</a>
</li>
<li >
<a href="release.html" title="Release">Release</a>
</li>
<li >
<a href="http:divider" title=""></a>
</li>
<li >
<a href="create-dev-environment.html" title="Create Dev Environment">Create Dev Environment</a>
</li>
<li >
<a href="manage-dev-environment.html" title="Manage Dev Environment">Manage Dev Environment</a>
</li>
<li >
<a href="setup-build-environment.html" title="Setup Build Environment">Setup Build Environment</a>
</li>
<li >
<a href="build.html" title="Build Trafodion">Build Trafodion</a>
</li>
<li >
<a href="http:divider" title=""></a>
</li>
<li >
<a href="code.html" title="Modify Code">Modify Code</a>
</li>
<li >
<a href="tests.html" title="Modify Tests">Modify Tests</a>
</li>
<li class="active">
<a href="#" title="Modify Documentation">Modify Documentation</a>
</li>
<li >
<a href="website.html" title="Modify Web Site">Modify Web Site</a>
</li>
<li >
<a href="wiki.html" title="Modify Wiki Pages">Modify Wiki Pages</a>
</li>
<li >
<a href="http:divider" title=""></a>
</li>
<li >
<a href="cplusplus-coding-guidelines.html" title="C++ Coding Guidelines">C++ Coding Guidelines</a>
</li>
</ul>
</div>
<div class="span4 bottom-description">
<blockquote><a href="http://trafodion.apache.org/">Apache Trafodion</a> is a webscale SQL-on-Hadoop solution enabling transactional or operational
workloads on Hadoop. <br /><br />The name "Trafodion" (the Welsh word for transactions, pronounced
"Tra-vod-eee-on") was chosen specifically to emphasize the differentiation that
Trafodion provides in closing a critical gap in the Hadoop ecosystem.<br /><br />
Trafodion builds on the scalability, elasticity, and flexibility of Hadoop. Trafodion extends
Hadoop to provide guaranteed transactional integrity, enabling new kinds of big data
applications to run on Hadoop.</blockquote>
</div>
</div>
</div>
</footer>
<div class="container subfooter">
<div class="row">
<div class="span12">
<p class="pull-right"><a href="#">Back to top</a></p>
<p class="copyright">Copyright ©2015 <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved.</p>
<hr/>
<div class="row span16">
<span>Disclaimer: Apache Trafodion is an effort undergoing incubation at the Apache Software Foundation (ASF), sponsored by the Apache Incubator PMC.
Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making
process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the
completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.</span>
<br/>
<br/>
<span>Apache, Apache Maven, Apache Maven Fluido Skin, the Apache feather logo, the Apache Maven project logo and the Apache Incubator project logo
are trademarks of The Apache Software Foundation.</span>
<br/>
<br/>
<span>
<a target="_blank" href="http://www.apache.org">
<img id="asf-logo" alt="Apache Software Foundation" src="images/logos/feather-small.gif"/>
</a>
<a target="_blank" href="http://incubator.apache.org/">
<img id="incubator-logo" alt="Apache Incubator" src="images/logos/egg-logo.gif"/>
</a>
</span>
</div> </div>
</div>
</div>
<!-- Le javascript
================================================== -->
<!-- Placed at the end of the document so the pages load faster -->
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.1/jquery.min.js"></script>
<script src="http://netdna.bootstrapcdn.com/twitter-bootstrap/2.3.2/js/bootstrap.min.js"></script>
<script src="./js/lightbox.min.js"></script>
<script src="./js/reflow-scroll.js"></script>
<script src="http://yandex.st/highlightjs/7.5/highlight.min.js"></script>
<script src="./js/reflow-skin.js"></script>
</body>
</html>