Kaynağa Gözat

HUE-2890 [doc] Merge dev doc to SDK doc

Romain Rigaux 8 yıl önce
ebeveyn
işleme
da3f3d3
7 değiştirilmiş dosya ile 154 ekleme ve 216 silme
  1. 0 55
      docs/dev/i18n.rst
  2. 0 14
      docs/dev/releasing.rst
  3. 0 127
      docs/dev/testing.rst
  4. 3 4
      docs/index.txt
  5. 17 2
      docs/manual.txt
  6. 133 13
      docs/sdk/sdk.md
  7. 1 1
      docs/user-guide/index.md

+ 0 - 55
docs/dev/i18n.rst

@@ -1,55 +0,0 @@
-.. -*- coding: utf-8 -*-
-
-=============================================
-Status of Internationalization (i18n) Support
-=============================================
-
-.. Note::
-    This documents the design of i18n in HUE, as well as the various degrees of
-    i18n support in different HUE applications.
-
-
----------------
-Design Overview
----------------
-
-Thanks to Django, HUE always receives unicode data from the browser. Data
-operations within the boundary of HUE should be done in unicode as much as
-possible. Data encoding occurs when the data exits HUE, in one of the following
-ways:
-
-Model Storage
-    These are data to go into a Django model, such as user firstname, lastname,
-    Beeswax saved query. Since the Django model layer handles unicode data, HUE
-    does not need to do any encoding.
-
-Hadoop Metadata
-    These include namespace metadata, Hive Metastore data, and so on. In
-    general, Hadoop metadata (where they support international characters) all
-    seem to be in UTF-8.
-
-Hadoop Data
-    This category includes file data, Hive table contents, HBase contents, etc.
-    The goal is to support custom encodings as specified by the user.
-    Eventually, on a view by view basis, the user may select the correct data
-    encoding. Meanwhile, for applications and views that do not yet expose such
-    flexibility, they may use the ``DEFAULT_SITE_ENCODING`` configuration
-    variable to interpret binary Hadoop Data.
-
-
----------------------
-Implementation Status
----------------------
-
-HDFS
-====
-HDFS namespace is in UTF-8. So we always encode to (and decode from) UTF-8.
-The ``libs.hadoop.fs.hadoopfs`` module speaks UTF-8 and handles this for us.
-The File Browser correctly handles HDFS namespace. *It does not yet expose file
-contents encoding in the UI*.
-
-Hive
-====
-Hive metadata (such as table comments) is also in UTF-8. The
-``beeswax.db_utils`` module converts between HUE (unicode) and Hive (UTF-8).
-Currently, Hive seems to only work with UTF-8 data.

+ 0 - 14
docs/dev/releasing.rst

@@ -1,14 +0,0 @@
-The version used in the Maven projects needs to be set by hand in the
-following files:
-- maven/pom.xml
-- desktop/libs/hadoop/java/pom.xml
-- desktop/libs/*/setup.py
-
-In the case of maven/pom.xml, change the first <version> tag. In the
-other cases, change the <version> tag within the <parent> tag.
-
-In addition, when running a release, all of these will need to be
-changed to remove "-SNAPSHOT". This will eventually be automated via
-the Maven release plugin, but is by hand for the moment. For release
-builds, you will also need to change MAVEN_VERSION in Makefile.vars to
-not include "-SNAPSHOT".

+ 0 - 127
docs/dev/testing.rst

@@ -1,127 +0,0 @@
-The short story
-===============
-
-Install the mini cluster (only once):
-```
-$ ./tools/jenkins/jenkins.sh slow
-```
-
-Run all the tests:
-```
-$ build/env/bin/hue test all
-```
-
-Or just some parts of the tests, e.g.:
-```
-$ build/env/bin/hue test specific impala
-$ build/env/bin/hue test specific impala.tests:TestMockedImpala
-$ build/env/bin/hue test specific impala.tests:TestMockedImpala.test_basic_flow
-```
-
-Jasmine tests (from your browser):
-
-  http://localhost:8000/jasmine
-
-
-Longer story
-============
-
-The ``test`` management command prepares the arguments (test app names)
-and passes them to nose (django_nose.nose_runner). Nose will then magically
-find all the tests to run.
-
-Tests themselves should be named *_test.py.  These will be found
-as long as they're in packages covered by django.  You can use the
-unittest frameworks, or you can just name your method with
-the word "test" at a word boundary, and nose will find it.
-See apps/hello/src/hello/hello_test.py for an example.
-
-
-Helpful command-line tricks
-===========================
-
-To run tests that do not depend on Hadoop, use:
-  build/env/bin/hue test fast
-
-To run all tests, use:
-  build/env/bin/hue test all
-
-To run only tests of a particular app, use:
-  build/env/bin/hue test specific <app>
-E.g.
-  build/env/bin/hue test specific filebrowser
-
-To run a specific test, use:
-  build/env/bin/hue test specific <test_func>
-E.g.
-  build/env/bin/hue test specific useradmin.tests:test_user_admin
-
-Start up pdb on test failures:
-  build/env/bin/hue test <args> --pdb --pdb-failure -s
-
-Point to an Impalad and trigger the Impala tests:
-  build/env/bin/hue test impala impalad-01.gethue.com
-
-
-Run the Jasmine tests
-=====================
-
-* NodeJS (https://nodejs.org/)
-* PhantomJS (npm install -g phantomjs-prebuilt)
-
-
-Special environment variables
-=============================
-
-DESKTOP_LOGLEVEL=<level>
-  level can be DEBUG, INFO, WARN, ERROR, or CRITICAL
-
-  When specified, the console logger is set to the given log level. A console
-  logger is created if one is not defined.
-
-DESKTOP_DEBUG
-  A shorthand for DESKTOP_LOG_LEVEL=DEBUG. Also turns on output HTML
-  validation.
-
-DESKTOP_PROFILE
-  Turn on Python profiling. The profile data is saved in a file. See the
-  console output for the location of the file.
-
-DESKTOP_LOG_DIR=<dir>
-  Specify the HUE log directory. Defaults to ./log.
-
-DESKTOP_DB_CONFIG=<db engine:db name:test db name:username:password:host:port>
-  Specify alternate DB connection parameters for HUE to use. Useful for
-  testing your changes against, for example, MySQL instead of sqlite. String
-  is a colon-delimited list.
-
-TEST_IMPALAD_HOST=impalad-01.gethue.com
-  Point to an Impalad and trigger the Impala tests.
-
-
-Writing tests that depend on Hadoop
-===================================
-
-Use pseudo_hdfs4.py!  You should tag such tests with "requires_hadoop", as follows:
-
-  from nose.plugins.attrib import attr
-
-  @attr('requires_hadoop')
-  def your_test():
-    ...
-
-
-Hudson Configuration
-====================
-
-Because building Hadoop (for the tests that require it) is slow, we've
-separated the Hudson builds into "fast" and "slow".  Both are run
-via scripts/hudson.sh, which should be kept updated with the latest
-and greatest in build technologies.
-
-Headless Windmill
-=================
-Ideally, all you need to do is install xvfb and run "xvfb-run bin/hue test_windmill".
-To debug, however, you'll need to be able to check out what's going on.  You can run
-"xvfb-run bash", followed by "x11vnc", and then connect to your X via VNC from another
-machine.  This lets you eavesdrop nicely.

+ 3 - 4
docs/index.txt

@@ -1,9 +1,9 @@
 image:images/hue_logo.png[Hue Logo]
 ===================================
 
-Installation
+Administrate
 ------------
-The link:manual.html[manual] has instructions to install Hue.
+The link:manual.html[manual] has instructions to install and administrate Hue.
 
 User Guide
 ----------
@@ -11,8 +11,7 @@ The link:user-guide/index.html[user guide] has instructions about how to use Hue
 
 SDK
 ---
-We encourage you to build an application within the Hue environment. See the
-link:sdk/sdk.html[SDK Documentation] to get started.
+We encourage you to link:sdk/sdk.html[build or extend applications] within the Hue environment.
 
 Release Notes
 -------------

+ 17 - 2
docs/manual.txt

@@ -1,5 +1,17 @@
-Hue Installation Guide
-======================
+<link rel="stylesheet" href="docbook.css" type="text/css" media="screen" title="no title" charset="utf-8"></link>
+<link rel="stylesheet" href="bootplus.css" type="text/css" media="screen" title="no title" charset="utf-8"></link>
+
+
+<h1><a href=index.html>Doc</a> > Hue Installation Guide</h1>
+
+
+<div class="row-fluid">
+  <div class="span3">
+
+[TOC]
+
+   </div>
+   <div class="span9">
 
 Introduction
 ------------
@@ -629,3 +641,6 @@ from your server. (See the <<logging,Hue Logging>> section. Please include the
 logs as a zip (or cut and paste the ones that look relevant) and send those with
 your bug reports.
 image:images/logs.png[]
+
+   </div>
+</div>

+ 133 - 13
docs/sdk/sdk.md

@@ -1,11 +1,19 @@
 
 <link rel="stylesheet" href="docbook.css" type="text/css" media="screen" title="no title" charset="utf-8"></link>
+<link rel="stylesheet" href="bootplus.css" type="text/css" media="screen" title="no title" charset="utf-8"></link>
+
+
+<h1><a href=../index.html>Doc</a> > Hue SDK Documentation</h1>
 
-Hue SDK Documentation
-=====================
+
+<div class="row-fluid">
+  <div class="span3">
 
 [TOC]
 
+   </div>
+   <div class="span9">
+
 Introduction and Overview
 =========================
 
@@ -847,22 +855,134 @@ Debugging Tips and Tricks
 
 * We recommend developing with the Chrome console.
 
-<!--
+The short story
+===============
+
+Install the mini cluster (only once):
+```
+$ ./tools/jenkins/jenkins.sh slow
+```
+
+Run all the tests:
+```
+$ build/env/bin/hue test all
+```
 
-## testing with windmill
+Or just some parts of the tests, e.g.:
+```
+$ build/env/bin/hue test specific impala
+$ build/env/bin/hue test specific impala.tests:TestMockedImpala
+$ build/env/bin/hue test specific impala.tests:TestMockedImpala.test_basic_flow
+```
 
-## Testing with django
+Jasmine tests (from your browser):
 
-# Packaging your app for installation elsewhere
+  http://localhost:8000/jasmine
 
-# Advanced Issues
 
-## Modifying the Hadoop plug-ins
+Longer story
+============
 
+The ``test`` management command prepares the arguments (test app names)
+and passes them to nose (django_nose.nose_runner). Nose will then magically
+find all the tests to run.
 
-Build system:
-- How to add external dependencies
-- Plugging into the status_bar.
-- Password_protecting and not password protecting.
+Tests themselves should be named *_test.py.  These will be found
+as long as they're in packages covered by django.  You can use the
+unittest frameworks, or you can just name your method with
+the word "test" at a word boundary, and nose will find it.
+See apps/hello/src/hello/hello_test.py for an example.
 
--->
+
+Helpful command-line tricks
+===========================
+
+To run tests that do not depend on Hadoop, use:
+  build/env/bin/hue test fast
+
+To run all tests, use:
+  build/env/bin/hue test all
+
+To run only tests of a particular app, use:
+  build/env/bin/hue test specific <app>
+E.g.
+  build/env/bin/hue test specific filebrowser
+
+To run a specific test, use:
+  build/env/bin/hue test specific <test_func>
+E.g.
+  build/env/bin/hue test specific useradmin.tests:test_user_admin
+
+Start up pdb on test failures:
+  build/env/bin/hue test <args> --pdb --pdb-failure -s
+
+Point to an Impalad and trigger the Impala tests:
+  build/env/bin/hue test impala impalad-01.gethue.com
+
+
+Run the Jasmine tests
+=====================
+
+* NodeJS (https://nodejs.org/)
+* PhantomJS (npm install -g phantomjs-prebuilt)
+
+
+Special environment variables
+=============================
+
+DESKTOP_LOGLEVEL=<level>
+  level can be DEBUG, INFO, WARN, ERROR, or CRITICAL
+
+  When specified, the console logger is set to the given log level. A console
+  logger is created if one is not defined.
+
+DESKTOP_DEBUG
+  A shorthand for DESKTOP_LOG_LEVEL=DEBUG. Also turns on output HTML
+  validation.
+
+DESKTOP_PROFILE
+  Turn on Python profiling. The profile data is saved in a file. See the
+  console output for the location of the file.
+
+DESKTOP_LOG_DIR=<dir>
+  Specify the HUE log directory. Defaults to ./log.
+
+DESKTOP_DB_CONFIG=<db engine:db name:test db name:username:password:host:port>
+  Specify alternate DB connection parameters for HUE to use. Useful for
+  testing your changes against, for example, MySQL instead of sqlite. String
+  is a colon-delimited list.
+
+TEST_IMPALAD_HOST=impalad-01.gethue.com
+  Point to an Impalad and trigger the Impala tests.
+
+
+Writing tests that depend on Hadoop
+===================================
+
+Use pseudo_hdfs4.py!  You should tag such tests with "requires_hadoop", as follows:
+
+  from nose.plugins.attrib import attr
+
+  @attr('requires_hadoop')
+  def your_test():
+    ...
+
+
+Hudson Configuration
+====================
+
+Because building Hadoop (for the tests that require it) is slow, we've
+separated the Hudson builds into "fast" and "slow".  Both are run
+via scripts/hudson.sh, which should be kept updated with the latest
+and greatest in build technologies.
+
+Headless Windmill
+=================
+Ideally, all you need to do is install xvfb and run "xvfb-run bin/hue test_windmill".
+To debug, however, you'll need to be able to check out what's going on.  You can run
+"xvfb-run bash", followed by "x11vnc", and then connect to your X via VNC from another
+machine.  This lets you eavesdrop nicely.
+
+
+   </div>
+</div>

+ 1 - 1
docs/user-guide/index.md

@@ -3,7 +3,7 @@
 <link rel="stylesheet" href="bootplus.css" type="text/css" media="screen" title="no title" charset="utf-8"></link>
 
 
-<h1>Hue User Guide</h1>
+<h1><a href=../index.html>Doc</a> > Hue User Guide</h1>
 
 
 <div class="row-fluid">