[TRAFODION-1507] Addressed review comments from Carol, Dave, and Roberta. Jenkins, skip test.
Project: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/commit/731a5c73 Tree: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/tree/731a5c73 Diff: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/diff/731a5c73 Branch: refs/heads/master Commit: 731a5c7338ed35fc70e1a4ab7cbb8826ae027a0b Parents: 0bfd379 Author: Gunnar Tapper <[email protected]> Authored: Mon Dec 7 18:14:40 2015 -0700 Committer: Gunnar Tapper <[email protected]> Committed: Mon Dec 7 18:14:40 2015 -0700 ---------------------------------------------------------------------- docs/src/site/markdown/build.md | 2 +- docs/src/site/markdown/contribute.md | 4 +- .../src/site/markdown/create-dev-environment.md | 4 +- docs/src/site/markdown/develop.md | 46 ++++++++++---------- docs/src/site/markdown/document.md | 29 ++++++------ docs/src/site/markdown/download.md | 4 +- .../site/markdown/enable-secure-trafodion.md | 2 +- docs/src/site/markdown/install-preparation.md | 4 +- docs/src/site/markdown/install.md | 16 +++---- docs/src/site/markdown/merge.md | 15 +++++++ docs/src/site/markdown/release-notes-0-8-0.md | 2 +- docs/src/site/markdown/release-notes-0-9-0.md | 2 +- docs/src/site/markdown/release-notes-1-0-0.md | 3 +- docs/src/site/markdown/release-notes-1-0-1.md | 11 ++--- docs/src/site/markdown/release-notes-1-1-0.md | 6 +-- docs/src/site/markdown/release-notes-1-3-0.md | 2 +- docs/src/site/markdown/release-notes.md | 2 +- docs/src/site/markdown/release.md | 10 ++--- .../site/markdown/setup-build-environment.md | 6 +-- docs/src/site/markdown/testing.md | 2 +- docs/src/site/site.xml | 4 +- 21 files changed, 98 insertions(+), 78 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/731a5c73/docs/src/site/markdown/build.md ---------------------------------------------------------------------- diff --git a/docs/src/site/markdown/build.md b/docs/src/site/markdown/build.md index 960b928..3140e1e 100644 --- a/docs/src/site/markdown/build.md +++ b/docs/src/site/markdown/build.md @@ -34,7 +34,7 @@ The source code for Apache Trafodion can be downloaded from [Apache Trafodion In cd <trafodion download directory> tar -xzf <tar file> -# Setup Environmental Variables +# Set Up Environmental Variables Start a new **```ssh```** session. Use the following commands to set up the Trafodion environmental variables. cd <Trafodion source directory> http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/731a5c73/docs/src/site/markdown/contribute.md ---------------------------------------------------------------------- diff --git a/docs/src/site/markdown/contribute.md b/docs/src/site/markdown/contribute.md index 356f398..c971b57 100644 --- a/docs/src/site/markdown/contribute.md +++ b/docs/src/site/markdown/contribute.md @@ -22,7 +22,7 @@ This page describes how you can contribute to the Trafodion project. First of all, a big **Thank You** from us for your interest in evaluating and/or using Trafodion. We truly appreciate it! Trafodion exists and continues to improve thanks to you. But you can help us and yourself more! -We are a community of volunteers working with the guidelines and policies of the Apache Software Foundation (the Apache Way) in mind. In that spirit, we welcome any kind of input you can provide to create better products. These contributions, whether you think of reporting bugs, supplying code enhancements, making improvements to our documentation, answering questions in our mailing lists, or anywhere else are valuable to everyone. Because each of these helps all of us make Trafodion better. +We are a community of volunteers working with the guidelines and policies of the Apache Software Foundation (the Apache Way) in mind. In that spirit, we welcome any kind of input you can provide to create better products. These contributions, whether you think of reporting bugs, supplying code enhancements, making improvements to our documentation, answering questions in our [mailing lists](mail-lists.html), or anywhere else are valuable to everyone. Because each of these helps all of us make Trafodion better. Your first step toward more involvement in our project is to subscribe to one or more of our [mailing lists](mail-lists.html). Next, please consider making your first contribution by simply sending an e-mail to our community discussing; for example: @@ -52,7 +52,7 @@ Want to be even more involved? Some areas you could consider: * Detailed and constructive feedback * Articles (case studies, white papers, etc) and presentations (speeches) about how our products helps or helped you. -These are just ideas to get you started. If you feel we missed something there, please let us know (via our [mailing lists](mail-lists.html) ). Together, we can grow Trafodion and its community. +These are just ideas to get you started. If you feel we missed something there, please let us know via our mailing lists. Together, we can grow Trafodion and its community. ---- http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/731a5c73/docs/src/site/markdown/create-dev-environment.md ---------------------------------------------------------------------- diff --git a/docs/src/site/markdown/create-dev-environment.md b/docs/src/site/markdown/create-dev-environment.md index acd840d..50eea4d 100644 --- a/docs/src/site/markdown/create-dev-environment.md +++ b/docs/src/site/markdown/create-dev-environment.md @@ -108,7 +108,7 @@ Command | Usage **```install_local_hadoop -p rand```** | Start with any random port number range between 9000 and 49000. **```install_local_hadoop -p <port>```** | Start with the specified port number. -For a list of ports that get configured and their default values, please refer to [Port Assignments](port-assignments.html). +For a list of ports that get configured and their default values, please refer to [Port Assignments](port-assignment.html). ### Sample Procedure Start a new **```ssh```** session and ensure that the Trafodion environmental variables are loaded. @@ -150,4 +150,4 @@ You need to do the following each time you download new source code. sqgen # Manage -Please refer to [Manage Development Environment](manage-dev-environment) for instructions. +Please refer to [Manage Development Environment](manage-dev-environment.html) for instructions. http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/731a5c73/docs/src/site/markdown/develop.md ---------------------------------------------------------------------- diff --git a/docs/src/site/markdown/develop.md b/docs/src/site/markdown/develop.md index 79656d8..78a5b35 100644 --- a/docs/src/site/markdown/develop.md +++ b/docs/src/site/markdown/develop.md @@ -26,23 +26,23 @@ You need to register as a Trafodion contributor before you can help us develop T <tr> <td><strong>Individual Contributor License Agreement (ICLA)</strong></td> <td>You should sign the ICLA before contributing content to the Trafodion source tree. (Required to become a committer.)</td> - <td><a href="https://www.apache.org/licenses/icla.txt"; target="_blank">ICLA Agreement</a><br /> - <a href="http://www.apache.org/licenses/"; target="_blank">Approval Process</a> + <td><a href="https://www.apache.org/licenses/icla.txt";>ICLA Agreement</a><br /> + <a href="http://www.apache.org/licenses/";>Approval Process</a> </td> </tr> <tr> <td><strong>Source Control</strong></td> <td>You must have a git account in order to contribute to the Trafodion source. If you haven't already done so, please join git.</td> - <td><a href="https://github.com/join"; target="_blank">Git Signup</a></td> + <td><a href="https://github.com/join";>Git Signup</a></td> </tr> <tr> <td><strong>Defect Tracking</strong></td> <td>In order to have certain permissions, including assigning issues to yourself, you need to be a Contributor in the project. Be sure to sign up for a JIRA account if you don't have one.</td> - <td><a href="https://issues.apache.org/jira/secure/Signup!default.jsp"; target="_blank">Jira Signup</a></td> + <td><a href="https://issues.apache.org/jira/secure/Signup!default.jspa";>Jira Signup</a></td> </tr> </table> -Please send an e-mail to the [Trafodion development list](mail-lists.hmtl) with the approved ICLA attached. Include your git and Jira IDs. +Please send an e-mail to the [Trafodion development list](mail-lists.html) with the approved ICLA attached. Include your git and Jira IDs. Wait for the response and then you're ready to help us develop Trafodion. @@ -61,56 +61,56 @@ You use the following tools and guidelines to develop Trafodion: <td><strong>Trafodion Architecture</strong></td> <td>Document</td> <td>Please review the Trafodion architecture to ensure that you understand how the different components related to each other.</td> - <td><a href="architecture-overview.html" target="_blank">Trafodion Architecture</a></td> + <td><a href="architecture-overview.html">Trafodion Architecture</a></td> </tr> <tr> <td><strong>Defect Tracking</strong></td> <td>Jira</td> <td>View all the Trafodion defects and enhancements requests in the Jira system hosted by Apache.</td> - <td><a href="https://issues.apache.org/jira/browse/TRAFODION"; target="_blank">Trafodion Jiras</a></td> + <td><a href="https://issues.apache.org/jira/browse/TRAFODION";>Trafodion Jiras</a></td> </tr> <tr> <td><strong>Defect Management</strong></td> <td>Document</td> <td>Please read about our approach to defect management. Mostly, any changes you'll make will be in response to a defect reported in Jira.</td> - <td><a href="defect-management.html" target="_blank">Defect Management</a></td> + <td><a href="defect-management.html">Defect Management (TBD)</a></td> </tr> <tr> <td><strong>Git Tools</strong></td> <td>git</td> - <td><p>Most of the Trafodion development is done on Linux. Development of the web site and/or documentation can successfully be done on Windows.</p><p>Please download the appropriate tool version; Linux or Windows.</p><p>Then, please refer to <a href="https://help.github.com/articles/set-up-git/"; target="_blank">GitHub Documentation</a> for information on how to set up your git environment. Ensure that you register your <a href="https://github.com/settings/ssh"; target="_blank">ssh keys</a>.</p></td> - <td><a href="http://git-scm.com/downloads"; target="_blank">Download git</a></td> + <td><p>Most of the Trafodion development is done on Linux. Development of the web site and/or documentation can successfully be done on Windows.</p><p>Please download the appropriate tool version; Linux or Windows.</p><p>Then, please refer to <a href="https://help.github.com/articles/set-up-git/";>GitHub Documentation</a> for information on how to set up your git environment. Ensure that you register your <a href="https://github.com/settings/ssh";>ssh keys</a>.</p></td> + <td><a href="http://git-scm.com/downloads";>Download git</a></td> </tr> <tr> <td><strong>Code Repository</strong></td> <td>git</td> <td>The full Trafodion source tree can be retrieved from either of these repositories.</td> - <td><a href="https://git-wip-us.apache.org/repos/asf/incubator-trafodion.git"; target="_blank">Apache Repository</a><br /><a href="https://github.com/apache/incubator-trafodion"; target="_blank">GitHub Mirror</a> + <td><a href="https://git-wip-us.apache.org/repos/asf/incubator-trafodion.git";>Apache Repository</a><br /><a href="https://github.com/apache/incubator-trafodion";>GitHub Mirror</a> </td> <tr> </tr> <td><strong>Code Organization</strong></td> <td>Document</td> <td>Please familiarize yourself with the Trafodion code organization.</td> - <td><a href="code-organization.html" target="_blank">Code Organization</a></td> + <td><a href="code-organization.html">Code Organization</a></td> </tr> <tr> <td><strong>C++ Coding Guidelines</strong></td> <td>Document</td> <td>Please read the coding guidelines for the Trafodion C++ code before making changes.</td> - <td><a href="cplusplus-coding-guidelines.html" target="_blank">C++ Coding Guidelines</a></td> + <td><a href="cplusplus-coding-guidelines.html">C++ Coding Guidelines</a></td> </tr> <tr> <td><strong>Debugging Tips</strong></td> <td>Document</td> <td>Documented tips describing how to debug your code in unit testing.</td> - <td><a href="debugging-tips.html" target="_blank">Debugging Tips</a></td> + <td><a href="debugging-tips.html">Debugging Tips (TBD)</a></td> </tr> <tr> <td><strong>Testing</strong></td> <td>Document</td> <td>Trafodion has a rich set of test suites for each of its components. You'll need to run the tests before submitting a code change for review.</td> - <td><a href="testing.html" target="_blank">How to Test</a></td> + <td><a href="testing.html">How to Test</a></td> </tr> <tr> <td><strong>Code Reviews</strong></td> @@ -118,15 +118,15 @@ You use the following tools and guidelines to develop Trafodion: <td> <p>We use GitHub pull-requests for code review. All of the activity on github is captured in ASF JIRA and/or ASF project mail archives by ASF INFRA team automation. In this way, we do not depend on github for accurate history of where contributions come from.</p> <p>Each pull-request title should start with a JIRA ID in brackets, so that activity can be logged to the correct JIRA issue.</p> - <p>Regardless of the title, the pull-request activity is also logged to the <a href="http://mail-archives.apache.org/mod_mbox/incubator-trafodion-codereview/"; target="_blank">code-review mail list</a>.</p> + <p>Regardless of the title, the pull-request activity is also logged to the <a href="http://mail-archives.apache.org/mod_mbox/incubator-trafodion-codereview/";>code-review mail list</a>.</p> </td> - <td><a href="https://github.com/apache/incubator-trafodion/pulls"; target="_blank">Current Pull Requests</a></td> + <td><a href="https://github.com/apache/incubator-trafodion/pulls";>Current Pull Requests</a></td> </tr> </body> </table> # Initial Setup -This set of tasks is performed **after** downloading the git tools. Refer to [Development Tools](#development_tools) above. +This set of tasks is performed **after** downloading the git tools. Refer to [Development Environment](#development_environment) above. You should not have to perform these tasks more than once. @@ -187,7 +187,7 @@ Perform the following steps to commit your changes. git push trafdeveloper_fork TRAFODION-1507 ## Create Pull Request -You changed code needs to be reviewed by a Trafodion committer. Therefore, you need to create a pull request for your private repository; for example: <https://github.com/trafdeveloper/incubator-trafodion>. +Your changed code needs to be reviewed by a Trafodion committer. Therefore, you need to create a pull request for your private repositoryc. # Generate pull request git pull-request @@ -204,11 +204,11 @@ Ensure that you include the Jira ID at the beginning of the title in your pull r The pull request gets reviewed by the committers and once you get a consensus, then the committer merges your changes into the main incubator-trafodion branch. ## Address Review Comments -Follow the GitHub conversation on you pull request (you should be automatically subscribed). Respond to questions and issues. +Follow the GitHub conversation on your pull request (you should be automatically subscribed). Respond to questions and issues. If you need to make additional changes, then do the following: -1. Checkout the code: **<code>git checkout TRAFODION-1507</code>** +1. Check out the code: **<code>git checkout TRAFODION-1507</code>** 2. Make the requested changes. 3. Run regression tests. 4. Commit the changes: **<code>git commit -a</code>** @@ -238,8 +238,8 @@ There are two approaches to reviewing logs. ### Approach 2 * Go to: <http://traf-logs.esgyn.com/PullReq/> -* Click on the number of the pull request. Example: <http://traf-logs.esgyn.com/PullReq/18/>. The next directory level is the build number. With multiple commits or re-tests, it is possible for a pull request to have multiple builds. +* Click on the number of the pull request. The next directory level is the build number. With multiple commits or re-tests, it is possible for a pull request to have multiple builds. * Under the build number is a directory for each specific job. Example: <http://traf-logs.esgyn.com/PullReq/18/35/regress-seabase-ahw2.2/> ## More Information -The check tests do not include all of the automated daily tests. If you (or another contributor) want, you can run additional tests on the pull request. Refer [automated test setup](automated-tests.html) for more information. \ No newline at end of file +The check tests do not include all of the automated daily tests. If you (or another contributor) want, you can run additional tests on the pull request. Refer [automated test setup (TBD)](automated-tests.html) for more information. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/731a5c73/docs/src/site/markdown/document.md ---------------------------------------------------------------------- diff --git a/docs/src/site/markdown/document.md b/docs/src/site/markdown/document.md index 021f322..55a1eb9 100644 --- a/docs/src/site/markdown/document.md +++ b/docs/src/site/markdown/document.md @@ -21,18 +21,20 @@ Documents do **not** include version information as part of the file name. Document | Source Format | Source Tree | Output Format --------------------------|-----------------------|------------------------------------------------|---------------------------- -Client Installation Guide | word | ```docs/src/resources/docs``` | PDF -Command Interface Guide | word | ```docs/src/resources/docs``` | PDF +Client Installation Guide | word | External (Word) | PDF +Command Interface Guide | word | External (Word) | PDF DCS Reference Guide | asciidoc | ```dcs/src/main/asciidoc``` | Web Book, PDF DCS APIs | javadoc | ```dcs/src/main/java``` | Web Book -odb User Guide | word | ```docs/src/resources/docs``` | PDF +odb User Guide | word | External (Word) | PDF REST Reference Guide | asciidoc | ```core/rest/src/main/asciidoc``` | Web Book, PDF REST APIs | javadoc | ```core/rest/src/main/java``` | Web Book -SQL Reference Manual | word | ```docs/src/resources/docs``` | PDF +SQL Reference Manual | word | External (Word) | PDF ## Web -The documentation is copied to the **```docs/target/docs```** directory on a per-release basis. This directory is referred to as the **release document directory** below. +**```docs/target/docs```** contains the **latest** version of the document. This practice makes it possible to link to a document in instructional text. + +In addition, the documentation is copied to the **```docs/target/docs```** directory on a per-release basis. This directory is referred to as the **release document directory** below. **Example** @@ -71,11 +73,12 @@ File/Directory | Content ## Word Documents Do the following: -1. Edit the document in **```docs/src/resources/docs```**. -2. Save a PDF version of the document in **```docs/src/resources/docs```**. +1. Edit the document. +2. Save a PDF version. 3. Build the web site using **```mvn clean site```** against the **```docs```** directory. - -The Word and PDF files will be copied to **```docs/target/docs```** directory. You will need to move the files to the final **Release Document Directory**; refer to [Publishing](#Publishing) below. +4. Create the **Release Document Directory**, if needed. +5. Copy the PDF files to the **Release Document Directory**. +6. Copy and overwrite the PDF to the **```docs/target/docs```** directory â latest version of the document. ## Asciidoc Documents Please refer to DCS [Contributing to Documentation](https://github.com/apache/incubator-trafodion/blob/master/dcs/src/main/asciidoc/_chapters/appendix_contributing_to_documentation.adoc) guidance for information about working on asciidoc-based documentation. @@ -102,12 +105,12 @@ You will need to copy/move the documentation from its generated location to the Document | Populate Release Document Directory --------------------------|------------------------------------------ -Client Installation Guide | Delete **```.docx```*** file, copy the **```.pdf```** file in **```docs/target/docs```** to the **Release Document Directory**. -Command Interface Guide | Delete **```.docx```*** file, copy the **```.pdf```** file in **```docs/target/docs```** to the **Release Document Directory**. +Client Installation Guide | Copy the **```.pdf```** file to **```docs/target/docs```** and **Release Document Directory**. +Command Interface Guide | Copy the **```.pdf```** file to **```docs/target/docs```** and **Release Document Directory**. DCS Reference Guide | Copy **```dcs/target/site/```** to the **Release Document Directory**. -odb User Guide | Delete **```.docx```*** file, copy the **```.pdf```** file in **```docs/target/docs```** to the **Release Document Directory**. +odb User Guide | Copy the **```.pdf```** file to **```docs/target/docs```** and **Release Document Directory**. REST Reference Guide | Copy **```core/rest/target/site/```** to the **Release Document Directory**. -SQL Reference Manual | Delete **```.docx```*** file, copy the **```.pdf```** file in **```docs/target/docs```** to the **Release Document Directory**. +SQL Reference Manual | Copy the **```.pdf```** file to **```docs/target/docs```** and **Release Document Directory**. **Example â Publishing the DCS Reference Guide** http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/731a5c73/docs/src/site/markdown/download.md ---------------------------------------------------------------------- diff --git a/docs/src/site/markdown/download.md b/docs/src/site/markdown/download.md index ba33c48..d5a68f2 100644 --- a/docs/src/site/markdown/download.md +++ b/docs/src/site/markdown/download.md @@ -12,7 +12,7 @@ limitations under the License. --> -This page describes how you download and install the Trafodion product environment. Please refer to [Create Development Environment](create-dev-environment.html] if you want to set up a Trafodion development environment (which includes the installation of a stand-alone Hadoop environment) based on the Trafodion source code. +This page describes how you download and install the Trafodion product environment. Please refer to [Create Development Environment](create-dev-environment.html) if you want to set up a Trafodion development environment (which includes the installation of a stand-alone Hadoop environment) based on the Trafodion source code. # Prerequisite Trafodion is installed onto an existing Hadoop environment. @@ -27,7 +27,7 @@ Not yet available. Build your own binaries from the Trafodion source code as follows: 1. [Setup Build Environment](setup-build-environment.html). -2. [Build Trafodion](build.html) \â use **```make package```**. +2. [Build Trafodion](build.html) â use **```make package```**. # Install Please refer to the [Install](install.html) instructions. http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/731a5c73/docs/src/site/markdown/enable-secure-trafodion.md ---------------------------------------------------------------------- diff --git a/docs/src/site/markdown/enable-secure-trafodion.md b/docs/src/site/markdown/enable-secure-trafodion.md index 7e23510..f0c73ea 100644 --- a/docs/src/site/markdown/enable-secure-trafodion.md +++ b/docs/src/site/markdown/enable-secure-trafodion.md @@ -12,7 +12,7 @@ limitations under the License. --> -This page describes how to Trafodion security. +This page describes how to enable Trafodion security. # Introduction If you do not enable security in Trafodion, a client interface to Trafodion may request a username and password, but Trafodion ignores the user name and password entered in the client interface, and the session runs as the database **```root```** user, **```DB__ROOT```**, without restrictions. If you want to restrict users, restrict access to certain users only, or restrict access to an object or operation, then you must enable security, which enforces authentication and authorization. You can enable security during installation by answering the installer's prompts or after installation by running the **```traf_authentication_setup```** script, which enables both authentication and authorization. For more information, see [Authentication Setup Script](#Authentication_Setup_Script) below. http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/731a5c73/docs/src/site/markdown/install-preparation.md ---------------------------------------------------------------------- diff --git a/docs/src/site/markdown/install-preparation.md b/docs/src/site/markdown/install-preparation.md index 3848746..40fbce4 100644 --- a/docs/src/site/markdown/install-preparation.md +++ b/docs/src/site/markdown/install-preparation.md @@ -34,7 +34,7 @@ Before installing Cloudera Manager, a minimum of 20 GB is needed to support the Check the available space for **```/var```** as follows: -* Start a putty or VNC terminal window agains the node where Cloudera Manager will be installed. +* Start a putty or VNC terminal window against the node where Cloudera Manager will be installed. * As a user with **```root```** privileges, verify that 20 GB of space is available to **```/var```**. cd /var @@ -76,7 +76,7 @@ The Trafodion installer prompts you to set up an authentication configuration fi If you wish to manually set up the authentication configuration file and enable security, then please refer to [Enabling Security Features in Trafodion](enable-secure-trafodion.html). -# PC Installation +# PC Tools If you are using a Windows PC, then additional PC software may be needed throughout the installation process. It is recommended that you pre-install the PC software that you need before continuing with the Trafodion installation. Install the following software: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/731a5c73/docs/src/site/markdown/install.md ---------------------------------------------------------------------- diff --git a/docs/src/site/markdown/install.md b/docs/src/site/markdown/install.md index 07fe6af..ec9caca 100644 --- a/docs/src/site/markdown/install.md +++ b/docs/src/site/markdown/install.md @@ -19,9 +19,9 @@ The Trafodion product environment is installed using the Trafodion Installer, wh # Preparation The Trafodion Installer assumes that you've performed the following steps before a Trafodion install: -1. **Cluster Requirements**: ensure that you cluster meets the Trafodion requirements. +1. **Cluster Requirements**: Ensure that your cluster meets the Trafodion requirements. 2. **Security Requirements**: Create the user ID that is used to run the Trafodion Installer. Review and configure LDAP, if desired. -3. **Prepare PC**: install software used when installing Trafodion on your PC. +3. **PC Tools**: Install software used when installing Trafodion on your PC. 4. **Install Hadoop**: Install Hadoop software supported by Trafodion. 5. **Validate Hadoop**: Validate that required Hadoop services are running. @@ -32,10 +32,10 @@ You use the following user IDs and passwords during the Trafodion installation. Logon | User ID | Password | Description -----------------------------------|----------------------------|-----------------------------|-------------------------------------------------------- -Cloudera Manager Web GUI logon | **```admin (default)```** | **```admin (default)```** | After installing Cloudera, you will be instructed to log on to the Cloudera Manager Web GUI. Use the default user ID and password (**```admin```**, **```admin```**). If you already had Cloudera installed, please use your previously defined user ID and password. -Ambari Web GUI logon | **```admin (default)```** | **```admin (default)```** | After downloading and setting up the Ambari repository, you will be instructed to log on to the Ambari Web GUI. Use the default user ID and password (**```admin```**, **```admin```**). If you already had Ambari installed, please use your previously defined user ID and password. -User ID with sudo Access | **```<sudo-username>```** | **```<password>```** | In the installation steps, you may be instructed to use **```sudo```** or **```sudo userid```** access. You will be using your user ID, which has been enabled with **```sudo```** access and [passwordless ssh](passwordless-ssg.html) to all nodes of the cluster. -Trafodion Logon | **```trafodion```** | **```traf123 (default)```** | The Trafodion installer **automatically creates** this user IDwhen Trafodion is installed. Do not create this user ID manually. +Cloudera Manager Web GUI logon | **```admin (default)```** | **```admin (default)```** | Cloudera only. After installing Cloudera, you will be instructed to log on to the Cloudera Manager Web GUI. Use the default user ID and password (**```admin```**, **```admin```**). If you already had Cloudera installed, please use your previously defined user ID and password. +Ambari Web GUI logon | **```admin (default)```** | **```admin (default)```** | Hortonworks only. After downloading and setting up the Ambari repository, you will be instructed to log on to the Ambari Web GUI. Use the default user ID and password (**```admin```**, **```admin```**). If you already had Ambari installed, please use your previously defined user ID and password. +User ID with sudo Access | **```<sudo-username>```** | **```<password>```** | In the installation steps, you may be instructed to use **```sudo```** or **```sudo userid```** access. You will be using your user ID, which has been enabled with **```sudo```** access and [passwordless ssh](passwordless-ssh.html) to all nodes of the cluster. +Trafodion Logon | **```trafodion```** | **```traf123 (default)```** | The Trafodion installer **automatically creates** this user ID when Trafodion is installed. Do not create this user ID manually. VNC Server Logon | **```trafodion```** | **```traf123 (default)```** | After installing Trafodion, you will be instructed to log on to the VNC server at port 1. Use the **```trafodion```** user ID and **```password```**. # Install Procedure @@ -53,9 +53,6 @@ Follow these steps if you have an older version of Trafodion that you want to up </td></tr></table> ## Installation - -<table><tr><td><strong>NOTE</strong><br /> If performing an upgrade: Please refer to [Upgrading Trafodion](#Upgrading_Trafodion) before proceeding.</td></tr></table> - At a high level, the following instructions consist of a single step: Command | User ID | Comments @@ -188,6 +185,7 @@ Perform a quick sanity check using the Trafodion Conversational Interface (**``` TEST1 --- SQL operation complete. + >> drop table test1; >> exit; The SQL commands above should run successfully. http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/731a5c73/docs/src/site/markdown/merge.md ---------------------------------------------------------------------- diff --git a/docs/src/site/markdown/merge.md b/docs/src/site/markdown/merge.md new file mode 100644 index 0000000..5cad622 --- /dev/null +++ b/docs/src/site/markdown/merge.md @@ -0,0 +1,15 @@ +<!-- + 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. +--> +This page will describe the committer work flow for git merges. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/731a5c73/docs/src/site/markdown/release-notes-0-8-0.md ---------------------------------------------------------------------- diff --git a/docs/src/site/markdown/release-notes-0-8-0.md b/docs/src/site/markdown/release-notes-0-8-0.md index a6c020b..4966cc9 100644 --- a/docs/src/site/markdown/release-notes-0-8-0.md +++ b/docs/src/site/markdown/release-notes-0-8-0.md @@ -14,7 +14,7 @@ This is the initial source-only release of the Apache Trafodion (incubating) project. -Build instructions are available [here](https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=61316378). +Build instructions are available [here](build.html). # Supported Platforms The following platforms are supported in this release. http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/731a5c73/docs/src/site/markdown/release-notes-0-9-0.md ---------------------------------------------------------------------- diff --git a/docs/src/site/markdown/release-notes-0-9-0.md b/docs/src/site/markdown/release-notes-0-9-0.md index a8f0757..f4ad658 100644 --- a/docs/src/site/markdown/release-notes-0-9-0.md +++ b/docs/src/site/markdown/release-notes-0-9-0.md @@ -14,7 +14,7 @@ This is the source-only release of the Apache Trafodion (incubating) project. This release provides support for HBase 0.98 and many new product features. -Build instructions are available [here](https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=61316378). +Build instructions are available [here](build.html). # Supported Platforms The following platforms are supported in this release. http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/731a5c73/docs/src/site/markdown/release-notes-1-0-0.md ---------------------------------------------------------------------- diff --git a/docs/src/site/markdown/release-notes-1-0-0.md b/docs/src/site/markdown/release-notes-1-0-0.md index 71abf33..4e2c898 100644 --- a/docs/src/site/markdown/release-notes-1-0-0.md +++ b/docs/src/site/markdown/release-notes-1-0-0.md @@ -14,7 +14,7 @@ This is the source-only release of the Apache Trafodion (incubating) project. This release provides a number of new features and improvements across the project plus a large number of bug fixes. -Build instructions are available [here](https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=61316378). +Build instructions are available [here](build.html). # Supported Platforms The following platforms are supported in this release. @@ -153,6 +153,7 @@ This release contains the following new features. This release contains fixes to around 85 defects, including 25 critical defects, 54 high defects, and 10 medium and low defects. Those defects were filed through [Launchpad](https://launchpad.net/trafodion/+milestone/r1.1). # Known Issues +All defect are located in [Launchpad](https://bugs.launchpad.net/trafodion). ## Getting TM error 97 when tables split or get moved http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/731a5c73/docs/src/site/markdown/release-notes-1-0-1.md ---------------------------------------------------------------------- diff --git a/docs/src/site/markdown/release-notes-1-0-1.md b/docs/src/site/markdown/release-notes-1-0-1.md index 7ec9848..83b2544 100644 --- a/docs/src/site/markdown/release-notes-1-0-1.md +++ b/docs/src/site/markdown/release-notes-1-0-1.md @@ -14,7 +14,7 @@ This is the source-only release of the Apache Trafodion (incubating) project. This release provides product-level collection of query statistics and critical bug fixes above [1.0.0](release-notes-1-0-0.html). -Build instructions are available [here](https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=61316378). +Build instructions are available [here](build.html). # Supported Platforms The following platforms are supported in this release. @@ -76,7 +76,7 @@ This release contains the following new features. <ul> <li>[Multi-Temperature Data](https://cwiki.apache.org/confluence/display/TRAFODION/Cmp-divisioning) (Complete But Not Tested)</li> </ul> - For more information about automated update statistics and index support enhancements, see the [Trafodion SQL Reference Manual](docs/Trafodion_SQL_Reference_Manaual.pdf). + For more information about automated update statistics and index support enhancements, see the [Trafodion SQL Reference Manual](docs/Trafodion_SQL_Reference_Manual.pdf). </td> <td></td> </tr> @@ -103,7 +103,7 @@ This release contains the following new features. <li>[Backup/Restore](https://wiki.trafodion.org/wiki/index.php/Backup_and_Restore). (Complete But Not Tested)</li> <li>Thread-Safe JDBC Type 2 Driver. (Complete But Not Tested)</li> </ul> - For more information about the new UNLOAD statement, see the [Trafodion SQL Reference Manual](docs/Trafodion_SQL_Reference_Manaual.pdf). + For more information about the new UNLOAD statement, see the [Trafodion SQL Reference Manual](docs/Trafodion_SQL_Reference_Manual.pdf). </td> <td></td> </tr> @@ -116,7 +116,7 @@ This release contains the following new features. <li>[Event Handling](https://wiki.trafodion.org/wiki/index.php/Trafodion_Manageability#Logging_Events) through UDFs and log4cpp.</li> <li>Collection of session and query statistics in [Repository Tables](https://wiki.trafodion.org/wiki/index.php/Trafodion_Manageability) (disabled by default)</li> </ul> - For more information about gathering SQL runtime statistics and canceling an executing query, see the [Trafodion SQL Reference Manual](docs/Trafodion_SQL_Reference_Manaual.pdf). + For more information about gathering SQL runtime statistics and canceling an executing query, see the [Trafodion SQL Reference Manual](docs/Trafodion_SQL_Reference_Manual.pdf). </td> <td></td> </tr> @@ -129,7 +129,7 @@ This release contains the following new features. <li>[Privilege checking for utilities](https://blueprints.launchpad.net/trafodion/+spec/security-privilege-updates).</li> <li>[Metadata Query Invalidation](https://blueprints.launchpad.net/trafodion/+spec/ddl-query-invalidation) (that is, detection and propagation of privilege changes to SQL compilers).</li> </ul> - For more information about ANSI schema support and privilege and authorization updates in this release, see the [Trafodion SQL Reference Manual](docs/Trafodion_SQL_Reference_Manaual.pdf). + For more information about ANSI schema support and privilege and authorization updates in this release, see the [Trafodion SQL Reference Manual](docs/Trafodion_SQL_Reference_Manual.pdf). </td> <td></td> </tr> @@ -143,6 +143,7 @@ This release contains fixes to around 85 defects, including 25 critical defects, # Known Issues Release 1.0.1 provides fixes to these bugs: + * **[1415165](https://bugs.launchpad.net/trafodion/+bug/1415165)**: MXOSRVR memory leak when stats are enabled * **[1421727](https://bugs.launchpad.net/trafodion/+bug/1421727)**: Default/aggregated stats type not publishing query stats * **[1416539](https://bugs.launchpad.net/trafodion/+bug/1416539)** Snapshot scan installer additions http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/731a5c73/docs/src/site/markdown/release-notes-1-1-0.md ---------------------------------------------------------------------- diff --git a/docs/src/site/markdown/release-notes-1-1-0.md b/docs/src/site/markdown/release-notes-1-1-0.md index af3a199..6339ea2 100644 --- a/docs/src/site/markdown/release-notes-1-1-0.md +++ b/docs/src/site/markdown/release-notes-1-1-0.md @@ -14,7 +14,7 @@ This is the source-only release of the Apache Trafodion (incubating) project. In addition to including a number of new features and improvements across the project, the focus of this release is to comply with Apache release guidelines. -Build instructions are available [here](https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=61316378). +Build instructions are available [here](build.html). # Supported Platforms The following platforms are supported in this release. @@ -105,7 +105,7 @@ This release contains the following new features. <ul> <li>Support for HP Data Services Manager (HP DSM), a unified, browser-based tool for management of Hadoop, Vertica, and now Trafodion data services. **NOTE**: The version of HP DSM that integrates with Trafodion is not yet available.</li> <li>Stability and overhead optimizations to reduce the overhead of capturing and maintaining query performance information (in repository tables).</li> - <li>Query cancel for DDL, update statistics, and additional child query operations. For details, see the CONTROL QUERY CANCEL statement in the [Trafodion SQL Reference Manual](docs/Trafodion_SQL_Reference_Manaual.pdf).</li> + <li>Query cancel for DDL, update statistics, and additional child query operations. For details, see the CONTROL QUERY CANCEL statement in the [Trafodion SQL Reference Manual](docs/Trafodion_SQL_Reference_Manual.pdf).</li> </ul> </td> <td></td> @@ -117,7 +117,7 @@ This release contains the following new features. <li>Security subsystem hardening improvements including performance and QA testing.</li> <li>Security enhancements for the Trafodion metadata, data loader, and Data Connectivity Services (DCS).</li> <li>Upgrade authorization.</li> - <li>Ability to grant privileges on behalf of a role using the GRANTED BY clause. For details, see the GRANT statements in the [Trafodion SQL Reference Manual](docs/Trafodion_SQL_Reference_Manaual.pdf).</li> + <li>Ability to grant privileges on behalf of a role using the GRANTED BY clause. For details, see the GRANT statements in the [Trafodion SQL Reference Manual](docs/Trafodion_SQL_Reference_Manual.pdf).</li> </ul> </td> <td></td> http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/731a5c73/docs/src/site/markdown/release-notes-1-3-0.md ---------------------------------------------------------------------- diff --git a/docs/src/site/markdown/release-notes-1-3-0.md b/docs/src/site/markdown/release-notes-1-3-0.md index 94e8eb5..62a8f16 100644 --- a/docs/src/site/markdown/release-notes-1-3-0.md +++ b/docs/src/site/markdown/release-notes-1-3-0.md @@ -14,7 +14,7 @@ This is the first release of the Apache Trafodion (incubating) project. In addition to including a number of new features and improvements across the project, the focus of this release is to comply with Apache release guidelines. -Build instructions are available [here](https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=61316378). +Build instructions are available [here](build.html). # Supported Platforms The following platforms are supported in this release. http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/731a5c73/docs/src/site/markdown/release-notes.md ---------------------------------------------------------------------- diff --git a/docs/src/site/markdown/release-notes.md b/docs/src/site/markdown/release-notes.md index 79518d0..0be9a26 100644 --- a/docs/src/site/markdown/release-notes.md +++ b/docs/src/site/markdown/release-notes.md @@ -16,7 +16,7 @@ The following releases have been created for Trafodion. Release | Description | Date --------------------------------------|-----------------------------------------------------------------------|-------------- -**[1.3.0](release-notes-1-3-0.html)** | First Apache release. | November 2015 +**[1.3.0](release-notes-1-3-0.html)** | First Apache release. | Pending **[1.1.0](release-notes-1-1-0.html)** | Major feature enhancements. Non-Apache release. | April 2015 **[1.0.1](release-notes-1-0-1.html)** | Defect repair. Non-Apache release. | February 2015 **[1.0.0](release-notes-1-0-0.html)** | Performance, stability, and new features. Non-Apache release. | January 2015 http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/731a5c73/docs/src/site/markdown/release.md ---------------------------------------------------------------------- diff --git a/docs/src/site/markdown/release.md b/docs/src/site/markdown/release.md index 8dad451..16e5391 100644 --- a/docs/src/site/markdown/release.md +++ b/docs/src/site/markdown/release.md @@ -19,7 +19,7 @@ This page describes how to create a Trafodion release. You have to be a Trafodio ## Create PGP Key If you haven't done so already, then you need to create a PGP key so that you can sign the release. Please refer to: http://www.apache.org/dev/openpgp.html#generate-key. -Please remember to store your private key is a secure place. +Please remember to store your private key in a secure place. **Example** @@ -28,7 +28,7 @@ Please remember to store your private key is a secure place. gpg -K (shows private key) ### Upload Public Key -Upload your public key to a public key server. We recommend using http://pgp.mit.edu/keyserver. +Upload your public key to a public key server. We recommend using https://pgp.mit.edu/. **Example** @@ -96,7 +96,7 @@ Trafodion uses git as its repository. When a new version is created, mark the r Once completed, a new source tar file exist in the distribution directory. ### Create Artifact Checksums and Signatures -**Assumption**: You've already created the signing key and registered it at the http://pgp.mit.edu/public repository. +**Assumption**: You've already created the signing key and registered it at the https://pgp.mit.edu/ repository. gpg --armor --output apache-trafodion-x.x.x-incubating-src.tar.gz.asc --detach-sig apache-trafodion-x.x.x-incubating-src.tar.gz gpg --verify apache-trafodion-x.x.x-incubating-src.tar.gz.asc @@ -127,7 +127,7 @@ Compare the two versions; for example, by using BCompare and the "Folder Compare **Note:** The git version will have some additional git folders and the distribution directory. ## Verify Apache Requirements -Verify checksums and signatures using the [Verify Signature](#Verify_Signature) instructions below. +Verify checksums and signatures using the [Verify Signature](#Verify_Signatures) instructions below. Ensure that the high-level directory contains valid version of: @@ -185,7 +185,7 @@ Check signatures and checksums. # Expect: gpg: requesting key A44C5A05 from hkp server pgpkeys.mit.edu gpg: /home/centos/.gnupg/trustdb.gpg: trustdb created - gpg: key A44C5A05: public key "Roberta Marton (CODE SIGNING KEY) <[email protected]>" imported + gpg: key A44C5A05: public key "Jane Doe (CODE SIGNING KEY) <[email protected]>" imported # Verify signature gpg --verify apache-trafodion-x.x.x-incubating-src.tar.gz.asc http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/731a5c73/docs/src/site/markdown/setup-build-environment.md ---------------------------------------------------------------------- diff --git a/docs/src/site/markdown/setup-build-environment.md b/docs/src/site/markdown/setup-build-environment.md index 4479397..6de4cd5 100644 --- a/docs/src/site/markdown/setup-build-environment.md +++ b/docs/src/site/markdown/setup-build-environment.md @@ -12,7 +12,7 @@ limitations under the License. --> -This page describes how you setup the Trafodion build environment. +This page describes how you set up the Trafodion build environment. # Supported Platforms Red Hat or Centos 6.x (6.4 or later) versions are supported as development and production platforms. @@ -75,7 +75,7 @@ Trafodion requires that several tools are installed in order to build. These too Tool | Description ---------------------------------------|----------------------------------------------------------------- **Bison** | General-purpose parser generator. -**ICU** | Setup of C/C++ and Java libraries providing Unicode and Globalization support for software applications. +**ICU** | Set of C/C++ and Java libraries providing Unicode and Globalization support for software applications. **LLVM** | Collection of modular and reusable compiler and tool-chain technologies. **Maven** | Build tool that is only installed if compatible version does not exist. **MPICH** | An implementation of the Message Passing Interface (MPI) standard. For use in Trafodion, MPICH must be built to force sockets to be used in both internode and intranode message passing. @@ -151,7 +151,7 @@ Please refer to [Build Tools Manual Installation](build-tools-manual.html). ## Verify Maven Check that Maven is installed. - maven --version + mvn --version If Maven is not found, then you should add Maven to your **```PATH```** environmental variable in **```.bashrc```** or **```.profile```**. http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/731a5c73/docs/src/site/markdown/testing.md ---------------------------------------------------------------------- diff --git a/docs/src/site/markdown/testing.md b/docs/src/site/markdown/testing.md index 0cfee3e..17895de 100644 --- a/docs/src/site/markdown/testing.md +++ b/docs/src/site/markdown/testing.md @@ -149,7 +149,7 @@ Further instructions for setting up and running the test can be found in source # Functional Tests ## Phoenix -The Phoenix tests provides basic functional tests for Trafodion. These tests were originally adapted from their counterpart at [salesforce.com](salesforce.com). +The Phoenix tests provides basic functional tests for Trafodion. These tests were originally adapted from their counterpart at salesforce.com. The tests are executed using Maven with a Python wrapper. You can run them the same way on your own workstation instance just like the way Jenkins runs them. Do the following: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/731a5c73/docs/src/site/site.xml ---------------------------------------------------------------------- diff --git a/docs/src/site/site.xml b/docs/src/site/site.xml index a057a09..f09afee 100644 --- a/docs/src/site/site.xml +++ b/docs/src/site/site.xml @@ -263,11 +263,13 @@ <item href="documentation.html" name="Documentation"/> <item href="faq.html" name="FAQ"/> <item href="release-notes.html" name="Release Notes"/> + <!-- <item href="http:divider" name=""/> <item href="udf-tutorial.html" name="UDF API Tutorial"/> + --> </menu> <menu name="Features"> - <item href="architecture.html" name="Architecture Overview"/> + <item href="architecture-overview.html" name="Architecture Overview"/> <item href="http:divider" name=""/> <item href="https://blueprints.launchpad.net/trafodion/+spec/security-ansi-schemas"; name="ANSI Schema Support"/> <item href="https://blueprints.launchpad.net/trafodion/+spec/ustat-automation"; name="Automated Update Statistics"/>
