Эх сурвалжийг харах

HUE-240. Update Help File for File Browser.

Paul Battaglia 15 жил өмнө
parent
commit
eeaa890c38

BIN
apps/filebrowser/src/filebrowser/static/help/images/6259464.jpg


BIN
apps/filebrowser/src/filebrowser/static/help/images/6259465.jpg


BIN
apps/filebrowser/src/filebrowser/static/help/images/6259466.jpg


BIN
apps/filebrowser/src/filebrowser/static/help/images/6259467.jpg


BIN
apps/filebrowser/src/filebrowser/static/help/images/6259468.jpg


BIN
apps/filebrowser/src/filebrowser/static/help/images/6259469.jpg


BIN
apps/filebrowser/src/filebrowser/static/help/images/6259470.jpg


BIN
apps/filebrowser/src/filebrowser/static/help/images/6259471.jpg


BIN
apps/filebrowser/src/filebrowser/static/help/images/6259472.jpg


BIN
apps/filebrowser/src/filebrowser/static/help/images/6259473.jpg


BIN
apps/filebrowser/src/filebrowser/static/help/images/6259474.jpg


BIN
apps/filebrowser/src/filebrowser/static/help/images/6259475.jpg


BIN
apps/filebrowser/src/filebrowser/static/help/images/6259559.jpg


BIN
apps/filebrowser/src/filebrowser/static/help/images/6259560.jpg


BIN
apps/filebrowser/src/filebrowser/static/help/images/filex.gif


+ 322 - 0
apps/filebrowser/src/filebrowser/static/help/index.html

@@ -0,0 +1,322 @@
+<h1><a name="FileBrowser-IntroducingHueFileBrowser"></a>Introducing Hue File Browser</h1>
+
+<p>The File Browser application enables you to browse and manipulate files and directories in the Hadoop Distributed File System (HDFS) while using Hue. With File Browser, you can:</p>
+
+<ul>
+	<li>Create directories, upload files, or rename, move, and delete files and directories. You can also change a file's or directory's owner, group, and permissions. See <a href="#FileBrowser-WorkingwithFilesandDirectories">Working with Files and Directories</a>.</li>
+	<li>Search for files, directories, owners, and groups (Cloudera Enterprise version only). See <a href="#FileBrowser-SearchingforFilesandDirectories">Searching for Files and Directories</a>.</li>
+	<li>View and edit files as text or binary. You can also download the files you are viewing and editing to your local system. See <a href="#FileBrowser-Viewing%2CEditing%2CandDownloadingFiles">Viewing, Editing, and Downloading Files</a>.</li>
+</ul>
+
+
+<h2><a name="FileBrowser-Contents"></a>Contents</h2>
+
+<style type='text/css'>/*<![CDATA[*/
+div.rbtoc1286391724285 {margin-left: 1.5em;padding: 0px;}
+div.rbtoc1286391724285 ul {margin-left: 0px;padding-left: 20px;}
+div.rbtoc1286391724285 li {margin-left: 0px;padding-left: 0px;}
+
+/*]]>*/</style><div class='rbtoc1286391724285'>
+<ul>
+    <li><a href='#FileBrowser-IntroducingHueFileBrowser'>Introducing Hue File Browser</a></li>
+    <li><a href='#FileBrowser-FileBrowserInstallationandConfiguration'> File Browser Installation and Configuration</a></li>
+    <li><a href='#FileBrowser-UsingFileBrowser'>Using File Browser</a></li>
+<ul>
+    <li><a href='#FileBrowser-StartingFileBrowser'> Starting File Browser</a></li>
+    <li><a href='#FileBrowser-WorkingwithFilesandDirectories'> Working with Files and Directories</a></li>
+<ul>
+    <li><a href='#FileBrowser-ChangingDirectories'>Changing Directories</a></li>
+    <li><a href='#FileBrowser-CreatingDirectories'>Creating Directories</a></li>
+    <li><a href='#FileBrowser-UploadingFiles'>Uploading Files</a></li>
+    <li><a href='#FileBrowser-DownloadingFilesusingtheFileBrowser'>Downloading Files using the File Browser</a></li>
+    <li><a href='#FileBrowser-Renaming%2CMoving%2CandDeletingFilesandDirectories'>Renaming, Moving, and Deleting Files and Directories</a></li>
+    <li><a href='#FileBrowser-ChangingaFile%27sorDirectory%27sOwner%2CGroup%2CorPermissions'>Changing a File's or Directory's Owner, Group, or Permissions</a></li>
+</ul>
+    <li><a href='#FileBrowser-SearchingforFilesandDirectories%28ClouderaEnterpriseversiononly%29'> Searching for Files and Directories (Cloudera Enterprise version only)</a></li>
+    <li><a href='#FileBrowser-Viewing%2CEditing%2CandDownloadingFiles'> Viewing, Editing, and Downloading Files</a></li>
+<ul>
+    <li><a href='#FileBrowser-ViewingandEditingFiles'>Viewing and Editing Files</a></li>
+    <li><a href='#FileBrowser-DownloadingFilesusingtheFileViewer'>Downloading Files using the File Viewer</a></li>
+</ul>
+</ul>
+</ul></div>
+
+<h1><a name="FileBrowser-FileBrowserInstallationandConfiguration"></a><a name="FileBrowser-FileBrowserInstallationandConfiguration"></a>File Browser Installation and Configuration</h1>
+
+<p>File Browser is one of the applications that can be installed as part of Hue. For more information about installing Hue, see <a href="https://wiki.cloudera.com/display/DOC/Hue+Installation">https://wiki.cloudera.com/display/DOC/Hue+Installation</a>.</p>
+
+<h1><a name="FileBrowser-UsingFileBrowser"></a>Using File Browser</h1>
+
+<p>This section describes how to start File Browser and use it to work with files and directories. </p>
+
+<h2><a name="FileBrowser-StartingFileBrowser"></a><a name="FileBrowser-StartingFileBrowser"></a>Starting File Browser</h2>
+
+<p>To start the File Browser application, click this icon <span class="image-wrap" style=""><img src="/filebrowser/static/help/images/6259473.jpg" height="27" width="27" style="border: 0px solid black"/></span> in the application bar at the bottom of the Hue web page. The <b>File Browser</b> window opens in the Hue web page.
+<br class="atl-forced-newline" />
+<br class="atl-forced-newline" /> <span class="image-wrap" style=""><img src="/filebrowser/static/help/images/6259472.jpg" height="372" width="714" style="border: 0px solid black"/></span></p>
+
+<h2><a name="FileBrowser-WorkingwithFilesandDirectories"></a><a name="FileBrowser-WorkingwithFilesandDirectories"></a>Working with Files and Directories</h2>
+
+<p>You can use File Browser to view the input and output files of your Map/Reduce jobs. Typically, you can save your output files in <tt>/tmp</tt> or in your home directory if your system administrator set one up for you. You must have the proper permissions to manipulate other user's files.</p>
+
+<h3><a name="FileBrowser-ChangingDirectories"></a>Changing Directories</h3>
+
+<p>To change to the root directory, click this icon <span class="image-wrap" style=""><img src="/filebrowser/static/help/images/6259467.jpg" height="28" width="24" style="border: 0px solid black"/></span> in the upper left corner of the <b>File Browser</b> window.</p>
+
+<p>To change to a different directory, double-click the directory name or parent directory dots, or this icon <span class="image-wrap" style=""><img src="/filebrowser/static/help/images/6259466.jpg" height="17" width="19" style="border: 0px solid black"/></span> next to the directory name in the <b>File Browser</b> window.</p>
+
+<p>To change to your home directory, click <b>My Home</b> in the <b>File Browser</b> window.</p>
+
+<div class='panelMacro'><table class='noteMacro'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="/static/art/help/warning.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td><b>Note</b><br />The <b>My Home</b> button is disabled if you do not have a home directory. Ask your system administrator to create a home directory for you.</td></tr></table></div>
+
+<h3><a name="FileBrowser-CreatingDirectories"></a>Creating Directories</h3>
+
+<p><b>To create a directory:</b></p>
+
+<ol>
+	<li>In the File Browser window, click <b>New Directory</b>.
+<br class="atl-forced-newline" />
+<br class="atl-forced-newline" /> <span class="image-wrap" style=""><img src="/filebrowser/static/help/images/6259472.jpg" height="372" width="714" style="border: 0px solid black"/></span>
+<br class="atl-forced-newline" />
+<br class="atl-forced-newline" /></li>
+	<li>In the <b>Create Directory</b> dialog box, enter a directory name and then click <b>Ok</b>.
+<br class="atl-forced-newline" /></li>
+</ol>
+
+
+<h3><a name="FileBrowser-UploadingFiles"></a>Uploading Files</h3>
+
+<p>You can upload text or binary files to the HDFS.</p>
+
+<p><b>To upload files:</b></p>
+
+<ol>
+	<li>In the <b>File Browser</b> window, browse to the directory where you want to upload the file.
+<br class="atl-forced-newline" />
+<br class="atl-forced-newline" /></li>
+	<li>Click <b>Upload Files</b>.
+<br class="atl-forced-newline" />
+<br class="atl-forced-newline" /></li>
+	<li>Browse to and select the file(s) you want to upload, and then click <b>Open</b>.
+<br class="atl-forced-newline" />
+<br class="atl-forced-newline" />
+The file(s) are uploaded to the directory you selected.</li>
+</ol>
+
+
+<div class='panelMacro'><table class='noteMacro'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="/static/art/help/warning.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td><b>Important</b><br />To upload files, your browser must have Flash enabled. If your installation of HUE is using HTTPS, self-signed certificates often confuse Flash. You can avoid using Flash by clicking the <b>upload without flash</b> link in the <b>Uploading files</b> message box, or by adding <tt>/filebrowser/upload</tt> to the end of the URL for HUE in your browser to display the following page.
+
+<p><span class="image-wrap" style=""><img src="/filebrowser/static/help/images/6259464.jpg" height="307" width="503" style="border: 0px solid black"/></span></p></td></tr></table></div>
+
+<h3><a name="FileBrowser-DownloadingFilesusingtheFileBrowser"></a>Downloading Files using the File Browser</h3>
+
+<p><b>To download files using the File Browser:</b></p>
+
+<ol>
+	<li>In the <b>File Browser</b> window, select the file you want to download.
+<br class="atl-forced-newline" />
+<br class="atl-forced-newline" /></li>
+	<li>Right-click and choose <b>Download File</b> from context menu.
+<br class="atl-forced-newline" />
+<br class="atl-forced-newline" /></li>
+	<li>Save or open the file on your local system.</li>
+</ol>
+
+
+<h3><a name="FileBrowser-Renaming%2CMoving%2CandDeletingFilesandDirectories"></a>Renaming, Moving, and Deleting Files and Directories</h3>
+
+<p><b>To rename a file or directory:</b></p>
+
+<ol>
+	<li>In the <b>File Browser</b> window, select the file or directory you want to rename.
+<br class="atl-forced-newline" />
+<br class="atl-forced-newline" /></li>
+	<li>Right-click and choose <b>Rename</b> from context menu.
+<br class="atl-forced-newline" />
+<br class="atl-forced-newline" /> <span class="image-wrap" style=""><img src="/filebrowser/static/help/images/6259471.jpg" height="307" width="718" style="border: 0px solid black"/></span>
+<br class="atl-forced-newline" />
+<br class="atl-forced-newline" /></li>
+	<li>Enter the new name and then click <b>Ok</b>.</li>
+</ol>
+
+
+<p><b>To move a file or directory:</b></p>
+
+<ol>
+	<li>In the <b>File Browser</b> window, select the file or directory you want to move.
+<br class="atl-forced-newline" />
+<br class="atl-forced-newline" /></li>
+	<li>Right-click and choose <b>Move</b> from context menu.
+<br class="atl-forced-newline" />
+<br class="atl-forced-newline" /></li>
+	<li>In the <b>Move</b> dialog box, browse to the directory where you want to move the file or directory, and then click <b>Ok</b>.</li>
+</ol>
+
+
+<div class='panelMacro'><table class='noteMacro'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="/static/art/help/warning.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td><b>Tip</b><br />While browsing in the <b>Move</b> dialog box, you can use the <b>My Home</b> and <b>New Directory</b> buttons.</td></tr></table></div>
+<p><br class="atl-forced-newline" /></p>
+
+<p><b>To delete a file or directory:</b></p>
+
+<ol>
+	<li>In the <b>File Browser</b> window, select the file or directory you want to delete. If you select a directory, all of the files and subdirectories contained within that directory are also deleted.
+<br class="atl-forced-newline" />
+<br class="atl-forced-newline" /></li>
+	<li>Right-click and choose <b>Delete</b> from context menu.
+<br class="atl-forced-newline" />
+<br class="atl-forced-newline" /></li>
+	<li>Click <b>Ok</b> to confirm the deletion.</li>
+</ol>
+
+
+<h3><a name="FileBrowser-ChangingaFile%27sorDirectory%27sOwner%2CGroup%2CorPermissions"></a>Changing a File's or Directory's Owner, Group, or Permissions</h3>
+
+<div class='panelMacro'><table class='noteMacro'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="/static/art/help/warning.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td><b>Note</b><br />Only the Hadoop superuser can change a file's or directory's owner, group, or permissions. The user who starts Hadoop is the Hadoop superuser. The Hadoop superuser account is not necessarily the same as a Hue superuser account. If you use User Manager to create a Hue user with the same user name and password as the Hadoop superuser, then that Hue user can change a file's or directory's owner, group, or permissions.</td></tr></table></div>
+
+<p><b>To change a file's or directory's owner or group:</b></p>
+
+<ol>
+	<li>In the <b>File Browser</b> window, select the file or directory whose owner or group you want to change.
+<br class="atl-forced-newline" />
+<br class="atl-forced-newline" /></li>
+	<li>Right-click and choose <b>Change Owner/Group</b> from context menu.
+<br class="atl-forced-newline" />
+<br class="atl-forced-newline" /></li>
+	<li>In the <b>Change Owner/Group</b> dialog box, choose the new user from the <b>User</b> drop-down menu.
+<br class="atl-forced-newline" />
+<br class="atl-forced-newline" /> <span class="image-wrap" style=""><img src="/filebrowser/static/help/images/6259474.jpg" height="176" width="510" style="border: 0px solid black"/></span>
+<br class="atl-forced-newline" />
+<br class="atl-forced-newline" /></li>
+	<li>Choose the new group from the <b>Group</b> drop-down menu.
+<br class="atl-forced-newline" />
+<br class="atl-forced-newline" /></li>
+	<li>Click <b>Ok</b> to make the changes.</li>
+</ol>
+
+
+<p><b>To change a file's or directory's permissions:</b></p>
+
+<ol>
+	<li>In the <b>File Browser</b> window, select the file or directory whose permissions you want to change.
+<br class="atl-forced-newline" />
+<br class="atl-forced-newline" /></li>
+	<li>Right-click and choose <b>Change Permissions</b> from context menu.
+<br class="atl-forced-newline" />
+<br class="atl-forced-newline" /></li>
+	<li>In the <b>Change Permissions</b> dialog box, select the permissions you want to assign and then click <b>Ok</b>.
+<br class="atl-forced-newline" />
+<br class="atl-forced-newline" /> <span class="image-wrap" style=""><img src="/filebrowser/static/help/images/6259475.jpg" height="169" width="270" style="border: 0px solid black"/></span>
+<br class="atl-forced-newline" /></li>
+</ol>
+
+
+<h2><a name="FileBrowser-SearchingforFilesandDirectories%28ClouderaEnterpriseversiononly%29"></a><a name="FileBrowser-SearchingforFilesandDirectories"></a>Searching for Files and Directories (Cloudera Enterprise version only)</h2>
+
+<p>If you are using the Cloudera Enterprise version of File Browser, you can use it to perform searches for:</p>
+
+<ul>
+	<li>Files and directories by name</li>
+	<li>Groups by name</li>
+	<li>Files and directories owned by a user</li>
+</ul>
+
+
+<p><b>To search for files and directories by name:</b></p>
+
+<ol>
+	<li>Choose <b>filename</b> from the drop-down menu at the top of the <b>File Browser</b> window.
+<br class="atl-forced-newline" />
+<br class="atl-forced-newline" /></li>
+	<li>Enter the name of the file or directory in the query search box.
+<br class="atl-forced-newline" />
+<br class="atl-forced-newline" />
+File Browser lists the files or directories matching the search criteria.
+<br class="atl-forced-newline" />
+<br class="atl-forced-newline" /> <span class="image-wrap" style=""><img src="/filebrowser/static/help/images/6259468.jpg" height="120" width="718" style="border: 0px solid black"/></span></li>
+</ol>
+
+
+<p><b>To search for groups by name:</b></p>
+
+<ol>
+	<li>Choose <b>group</b> from the drop-down menu at the top of the <b>File Browser</b> window.
+<br class="atl-forced-newline" />
+<br class="atl-forced-newline" /></li>
+	<li>Enter the name of the group in the query search box.
+<br class="atl-forced-newline" />
+<br class="atl-forced-newline" />
+File Browser lists the groups matching the search criteria.</li>
+</ol>
+
+
+<p><b>To search for files and directories owned by a user:</b></p>
+
+<ol>
+	<li>Choose <b>owner</b> from the drop-down menu at the top of the <b>File Browser</b> window.
+<br class="atl-forced-newline" />
+<br class="atl-forced-newline" /></li>
+	<li>Enter the user's name in the query search box.
+<br class="atl-forced-newline" />
+<br class="atl-forced-newline" />
+File Browser lists the files and directories owned by the specified user.</li>
+</ol>
+
+
+<h2><a name="FileBrowser-Viewing%2CEditing%2CandDownloadingFiles"></a><a name="FileBrowser-Viewing%2CEditing%2CandDownloadingFiles"></a>Viewing, Editing, and Downloading Files</h2>
+
+<p>You can view and edit files as text or binary. You can also download files from the HDFS.</p>
+
+<h3><a name="FileBrowser-ViewingandEditingFiles"></a>Viewing and Editing Files</h3>
+
+<p><b>To view and edit files:</b></p>
+
+<ol>
+	<li>In the <b>File Browser</b> window, double-click the file you want to view, or right-click and choose <b>View File</b> from context menu.
+<br class="atl-forced-newline" />
+File Browser displays the first 4,096 bytes of the file in the <b>File Viewer</b> window.
+<br class="atl-forced-newline" />
+<br class="atl-forced-newline" /> <span class="image-wrap" style=""><img src="/filebrowser/static/help/images/6259469.jpg" height="274" width="584" style="border: 0px solid black"/></span>
+<br class="atl-forced-newline" />
+<br class="atl-forced-newline" /></li>
+	<li>If the file is larger than 4,096 bytes, click these icons <span class="image-wrap" style=""><img src="/filebrowser/static/help/images/6259465.jpg" height="19" width="35" style="border: 0px solid black"/></span> in the upper right corner of the <b>File Viewer</b> window to scroll through the file.
+<br class="atl-forced-newline" />
+<br class="atl-forced-newline" /></li>
+	<li>To switch the view from text to binary, click <b>View as Binary</b> to view a hexdump. To switch the view from binary to text, click <b>View as Text</b>.
+<br class="atl-forced-newline" />
+<br class="atl-forced-newline" /></li>
+	<li>To view the file's location in the HDFS, click <b>View File Location</b>. File Browser displays the file's location in the <b>File Browser</b> window.
+<br class="atl-forced-newline" />
+<br class="atl-forced-newline" /></li>
+	<li>If you are viewing a text file, you can edit the contents by clicking <b>Edit File</b>.
+<br class="atl-forced-newline" />
+<br class="atl-forced-newline" />
+File Browser displays the contents of the file in the <b>File Editor</b> window.
+<br class="atl-forced-newline" />
+<br class="atl-forced-newline" /> <span class="image-wrap" style=""><img src="/filebrowser/static/help/images/6259470.jpg" height="308" width="577" style="border: 0px solid black"/></span>
+<br class="atl-forced-newline" />
+<br class="atl-forced-newline" /></li>
+	<li>Edit the file and then click <b>Save</b> or <b>Save As</b> to save the file.</li>
+</ol>
+
+
+<h3><a name="FileBrowser-DownloadingFilesusingtheFileViewer"></a>Downloading Files using the File Viewer</h3>
+
+<p><b>To download files from using the File Viewer:</b></p>
+
+<ol>
+	<li>In the <b>File Browser</b> window, double-click the file you want to download, or right-click and choose <b>View File</b> from context menu.
+<br class="atl-forced-newline" />
+<br class="atl-forced-newline" /></li>
+	<li>Click <b>Download</b>.
+<br class="atl-forced-newline" />
+<br class="atl-forced-newline" /> <span class="image-wrap" style=""><img src="/filebrowser/static/help/images/6259469.jpg" height="252" width="537" style="border: 0px solid black"/></span>
+<br class="atl-forced-newline" />
+<br class="atl-forced-newline" /></li>
+	<li>Save or open the file on your local system.</li>
+</ol>
+
+
+<p><br class="atl-forced-newline" /></p>
+
+				    					    <br/>
+                        

+ 0 - 44
apps/filebrowser/src/filebrowser/static/help/index.md

@@ -1,44 +0,0 @@
-File Browser, File Viewer, and File Editor
-==========================================
-<a target="FileBrowser"><img src="/filebrowser/static/art/icon_large.png" class="help-logo"/></a>
-
-<img src="/filebrowser/static/help/images/filex.gif"/>
-  
-File Browser
-------------
-The File Browser exposes a graphical view of your
-file system.  You can use it to examine the files,
-download and upload them, change permissions, etc.
-
-Many of the operations are exposed through a right-click
-menu.  Double click to step into a directory.
-
-### Permission Denied Errors
-
-You may often see errors like the following: 
-<pre><code>Permission denied: user=alice, access=WRITE, inode="secret":bob:supergroup:rwxr-xr-x"</pre></code>  
-
-This indicates that the user "alice" (that's you in this case) is not
-able to access the file or directory "secret", which is
-owned by "bob" and has the permissions you see.
-
-Typically, <a target="FileBrowser" href="/filebrowser/view/tmp">/tmp</a>
-is world-writable, so you can stick output there.  Your system
-administrator should also have set up a home directory (`/user/foo`)
-for you.
-
-File Viewer
------------
-Double-clicking on a file (or using the right-click menu)
-lets you see the contents of a file.  If the file is
-a binary file, switch to the "binary" view to see a hexdump.
-The viewer is paged, so that you only see portions of the
-file at a time.  This allows the file viewer to display
-very very large files.
-
-File Editor
------------
-For very small files, typically configuration files, you
-can use the file editor to edit files directly on the
-remote file system, without downloading and then
-re-uploading them.