Parcourir la source

HUE-8888 [docs] Simplify the end user guide

Romain il y a 6 ans
Parent
commit
7039a78f1e

+ 4 - 4
docs/docs-site/content/user/browsers/_index.md → docs/docs-site/content/user/browsing/_index.md

@@ -1,11 +1,11 @@
 ---
-title: "Data Catalog"
+title: "Browsing"
 date: 2019-03-13T18:28:09-07:00
 draft: false
-weight: 4
+weight: 3
 ---
 
-Hue Browsers power the Data Catalog. They let you easily search, glance and perform actions on data or jobs in Cloud or on premise clusters.
+Browsers power the Data Catalog. They let you easily search, glance and perform actions on data or jobs in Cloud or on premise clusters.
 
 The browsers can be "enriched" with [Search and Tagging](http://gethue.com/improved-sql-exploration-in-hue-4-3/) by metadata services.
 
@@ -227,7 +227,7 @@ column range, etc. Remember that if you ever need help with the
 searchbar, you can use the help menu that pops up while typing, which
 will suggest next steps to complete your query.
 
-## Solr Indexes / Collections
+## Solr Indexes
 
 Solr indexes can be created and are listed in the interface.
 

+ 0 - 45
docs/docs-site/content/user/dashboards/_index.md

@@ -1,45 +0,0 @@
----
-title: "Dashboard"
-date: 2019-03-13T18:28:09-07:00
-draft: false
-weight: 3
----
-
-Dashboards are an interactive way to explore your data quickly and easily. No programming is required and the analysis is done by drag & drops and clicks.
-
-Read more about [Dashboards](http://gethue.com/search-dashboards/).
-
-## Concepts
-
-Simply drag & drop widgets that are interconnected together. This is great for exploring new datasets or monitoring without having to type.
-
-### Importing
-
-Any CSV file can be dragged & dropped and ingested into an index in a few clicks via the Data Import Wizard [link]. The indexed data is immediately queryable and its facets/dimensions will be very fast to explore.
-
-### Browsing
-
-The Collection browser got polished in the last releases and provide more information on the columns. The left metadata assist of Hue 4 makes it handy to list them and peak at their content via the sample popup.
-
-### Querying
-
-The search box support live prefix filtering of field data and comes with a Solr syntax autocomplete in order to make the querying intuitive and quick. Any field can be inspected for its top values of statistic. This analysis happens very fast as the data is indexed.
-
-## Databases
-
-### Solr
-
-#### Autocomplete
-
-The top search bar offers a [full autocomplete](http://gethue.com/intuitively-discovering-and-exploring-a-wine-dataset-with-the-dynamic-dashboards/) on all the values of the index.
-
-#### More Like This
-The “More like This” feature lets you selected fields you would like to use to find similar records. This is a great way to find similar issues, customers, people... with regard to a list of attributes.
-
-### SQL
-
-Any configured SQL source can be queried via the dashboards.
-
-## Reports
-
-This is work in progress but dashboards will soon offer a classic reporting option.

+ 15 - 3
docs/docs-site/content/user/editor/_index.md → docs/docs-site/content/user/querying/_index.md

@@ -1,17 +1,17 @@
 ---
-title: "Editor"
+title: "Querying"
 date: 2019-03-13T18:28:09-07:00
 draft: false
 weight: 2
 ---
 
-The goal of Hue's Editor is to make data querying easy and productive.
+The goal of Hue's is to make data querying easy and productive.
 
 It focuses on SQL but also supports job submissions. It comes with an intelligent autocomplete, [risk alerts and self service troubleshooting](http://gethue.com/hue-4-sql-editor-improvements/) and query assistance.
 
 Any editor can be `starred` next to its name so that it becomes the default editor and the landing page when logging in.
 
-Configuration of the connectors is currently done by the [Administrator](/administrator/configuration/editor/).
+Configuration of the connectors is currently done by the [Administrator](/administrator/configuration/connectors/).
 
 ## Concepts
 ### Running Queries
@@ -298,3 +298,15 @@ Job Properties setting.
 ### DistCp
 
 A DistCp job design consists of a DistCp command.
+
+## Dashboards
+
+Dashboards are an interactive way to explore your data quickly and easily. No programming is required and the analysis is done by drag & drops and clicks.
+
+Read more about [Dashboards](http://gethue.com/search-dashboards/).
+
+Simply drag & drop widgets that are interconnected together. This is great for exploring new datasets or monitoring without having to type.
+
+The top search bar offers a [full autocomplete](http://gethue.com/intuitively-discovering-and-exploring-a-wine-dataset-with-the-dynamic-dashboards/) on all the values of the index.
+
+The “More like This” feature lets you selected fields you would like to use to find similar records. This is a great way to find similar issues, customers, people... with regard to a list of attributes.

+ 0 - 174
docs/docs-site/content/user/scheduler/_index.md

@@ -1,174 +0,0 @@
----
-title: "Scheduler"
-date: 2019-03-13T18:28:09-07:00
-draft: false
-weight: 5
----
-
-The application lets you build workflows and then schedule them to run regularly automatically.
-A monitoring interface shows the progress, logs and allow actions like pausing or stopping jobs.
-
-The Oozie Editor/Dashboard application allows you to define Oozie
-workflow, coordinator, and bundle applications, run workflow,
-coordinator, and bundle jobs, and view the status of jobs. For
-information about Oozie, see [Oozie
-Documentation](https://oozie.apache.org/docs/).
-
-A workflow application is a collection of actions arranged in a directed
-acyclic graph (DAG). It includes two types of nodes:
-
--   Control flow - start, end, fork, join, decision, and kill
--   Action - Jobs
-
-A coordinator application allows you to define and execute recurrent and
-interdependent workflow jobs. The coordinator application defines the
-conditions under which the execution of workflows can occur.
-
-A bundle application allows you to batch a set of coordinator
-applications.
-
-
-## Workflows
-
-In the Workflow Editor you can easily perform operations on Oozie action
-and control nodes.
-
-### Action Nodes
-
-The Workflow Editor supports dragging and dropping action nodes. As you
-move the action over other actions and forks, highlights indicate active
-areas. If there are actions in the workflow, the active areas are the
-actions themselves and the areas above and below the actions. If you
-drop an action on an existing action, a fork and join is added to the
-workflow.
-
--   Add actions to the workflow by clicking the action
-    button and drop the action on the
-    workflow. The Edit Node screen displays.
-    1.  Set the action properties and click **Done**. Each action in a
-        workflow must have a unique name.
-
--   Copy an action by clicking the **Copy**
-    button.
-
-1.  The action is opened in the Edit Node screen.
-2.  Edit the action properties and click **Done**. The action is added
-    to the end of the workflow.
-
--   Delete an action by clicking the Trash button.
--   Edit an action by clicking the Edit button.
--   Change the position of an action by left-clicking and dragging an
-    action to a new location.
-
-### Control Nodes
-
--   Create a fork and join by dropping an action on top of another
-    action.
--   Remove a fork and join by dragging a forked action and dropping it
-    above the fork.
--   Convert a fork to a decision by clicking the
-    Fork button.
--   To edit a decision:
-    1.  Click the Edit button.
-    2.  Fill in the predicates that determine which action to perform
-        and select the default action from the drop-down list.
-    3.  Click **Done**.
-
-**Note**: worfklows.xml and their job.properties
-cab also directly be selected and executed via the File Browser.
-
-## Schedules
-
-In Coordinator Manager you create Oozie coordinator applications and
-submit them for execution.
-
-### Editing a Coordinator
-
-In the Coordinator Editor you specify coordinator properties and the
-datasets on which the workflow scheduled by the coordinator will operate
-by stepping through screens in a wizard. You can also advance to
-particular steps and revisit steps by clicking the Step "tabs" above the
-screens. The following instructions walk you through the wizard.
-
-1.  Type a name, select the workflow, check the **Is shared checkbox**
-    to share the job, and click **Next**. If the Coordinator Editor was
-    opened after scheduling a workflow, the workflow will be set.
-2.  Select how many times the coordinator will run for each specified
-    unit, the start and end times of the coordinator, the timezone of
-    the start and end times, and click **Next**. Times must be expressed
-    as UTC times. For example, to run at 10 pm PST, specify a start time
-    of 6 am UTC of the following day (+8 hours) and set the Timezone
-    field to America/Los\_Angeles.
-3.  Click **Add** to select an input dataset and click **Next**. If no
-    datasets exist, follow the procedure in [Creating a
-    Dataset](#creatingDataset).
-4.  Click **Add** to select an output dataset. Click **Save
-    coordinator** or click **Next** to specify advanced settings.
-5.  To share the coordinator with all users, check the **Is****shared**
-    checkbox.
-6.  Fill in parameters to pass to Oozie, properties that determine how
-    long a coordinator will wait before timing out, how many
-    coordinators can run and wait concurrently, and the coordinator
-    execution policy.
-7.  Click **Save coordinator**.
-
-### Creating a Dataset
-
-1.  In the Coordinator Editor, do one of the following:
-    -   Click **here** in the Inputs or Outputs pane at the top of the
-        editor.
-    -   In the pane at the left, click the **Create new** link. Proceed
-        with [Editing a Dataset](#editingDataset).
-
-### Editing a Dataset
-
-1.  Type a name for the dataset.
-2.  In the Start and Frequency fields, specify when and how often the
-    dataset will be available.
-3.  In the URI field, specify a URI template for the location of the
-    dataset. To construct URIs and URI paths containing dates and
-    timestamps, you can specify the variables
-    ${YEAR},${MONTH},${DAY},${HOUR},${MINUTE}. For example:
-    hdfs://foo:9000/usr/app/stats/${YEAR}/${MONTH}/data.
-4.  In the Instance field, click a button to choose a default, single,
-    or range of data instances. For example, if frequency==DAY, a window
-    of the last rolling 5 days (not including today) would be expressed
-    as start: -5 and end: -1. Check the advanced checkbox to display a
-    field where you can specify a coordinator [EL
-    function](http://archive.cloudera.com/cdh4/cdh/4/oozie/CoordinatorFunctionalSpec.html).
-5.  Specify the timezone of the start date.
-6.  In the Done flag field, specify the flag that identifies when input
-    datasets are no longer ready.
-
-
-## Bundles
-
-A bundle consists in a collection of schedules.
-
-### Creating a Bundle
-
-1.  Click the **Create** button at the top right.
-2.  In the Name field, type a name.
-3.  In the Kick off time field, choose a kick off time.
-4.  Check the Is shared checkbox to allow all users to access the
-    workflow.
-5.  Click **Save**. The Bundle Editor opens. Proceed with [Editing a
-    Bundle](#editingBundle).
-
-### Editing a Bundle
-
-In the Bundle Editor, you specify properties by stepping through screens
-in a wizard. You can also advance to particular steps and revisit steps
-by clicking the Step "tabs" above the screens. The following
-instructions walk you through the wizard.
-
-1.  Click **Add** to select a coordinator that the bundle will kick off.
-2.  Choose the kick off time. The time must be expressed as a UTC time.
-    For example, to run at 10 pm PST, specify a start time of 6 am UTC
-    of the following day (+8 hours).
-3.  To share the bundle with all users, check the **Is shared**
-    checkbox.
-4.  Click **Next** to specify advanced settings or click **Save
-    bundle**.
-5.  Fill in parameters to pass to Oozie.
-6.  Click **Save bundle**.