Jelajahi Sumber

HUE-9018 [docs] Remove additional baseUrl for images as not needed anymore

Romain 6 tahun lalu
induk
melakukan
52bd3c0720

+ 1 - 6
docs/docs-site/config.toml

@@ -1,5 +1,4 @@
-baseUrl = 'https://docs.gethue.com/' # Note: also in [params]
-# baseURL = '/' # Flip both to see images in developement mode
+baseUrl = 'https://docs.gethue.com/'
 
 languageCode = "en-us"
 title = "Hue Documentation"
@@ -12,10 +11,6 @@ theme = "hugo-theme-learn"
 home = [ "HTML", "RSS", "JSON"]
 
 [params]
-  # For logo and favicon partials
-  baseUrl = 'https://docs.gethue.com/'
-  # baseURL = '/'
-
   # Prefix URL to edit current page. Will display an "Edit this page" button on top right hand corner of every page.
   # Useful to give opportunity to people to create merge request for your doc.
   editURL = "https://github.com/cloudera/hue/blob/master/docs/docs-site/content/"

+ 1 - 1
docs/docs-site/content/_index.md

@@ -5,7 +5,7 @@ weight = 1
 chapter = false
 pre = "<b>1. </b>"
 +++
-![Hue Logo Back-end]({{% param baseURL %}}images/hue_logo.png)
+![Hue Logo Back-end](/images/hue_logo.png)
 
 <span style="font-size:52px; text-align:center; display: block">Documentation</span>
 

+ 1 - 1
docs/docs-site/content/administrator/administration/operations.md

@@ -164,4 +164,4 @@ If `django_debug_mode` is enabled, instrumentation is automatically enabled. Thi
 
 ## Database
 
-See the dedicated [Database section]({{% param baseURL %}}administrator/administration/database/).
+See the dedicated [Database section](/administrator/administration/database/).

+ 4 - 4
docs/docs-site/content/administrator/administration/reference.md

@@ -9,13 +9,13 @@ A recommended setup consists in:
 
 * 2 Hues and 1 Load Balancer
 * Databases: MySQL InnoDB, PostgreSQL, Oracle
-* Authentication: [LDAP or Username/Password]({{% param baseURL %}}administrator/configuration/server/#authentication)
+* Authentication: [LDAP or Username/Password](/administrator/configuration/server/#authentication)
 
 Typical setups range from 2 to 5 Hue servers, e.g. 3 Hue servers, 300+ unique users, peaks at 125 users/hour with 300 queries
 
 In practice ~50 users / Hue peak time is the rule of thumb. This is accounting for the worse case scenarios and it will go much higher with the upcoming Task Server [HUE-8738](https://issues.cloudera.org/browse/HUE-8738) and Gunicorn [HUE-8739](https://issues.cloudera.org/browse/HUE-8739) integrations. Most of the scale issues are actually related to resource intensive operations like large download of query results or when an RPC call from Hue to a service is slow (e.g. submitting a query hangs when Hive is slow), not by the number of users.
 
-![Reference Architecture]({{% param baseURL %}}images/hue_architecture.png)
+![Reference Architecture](/images/hue_architecture.png)
 
 
 ## General Performance
@@ -24,7 +24,7 @@ In practice ~50 users / Hue peak time is the rule of thumb. This is accounting f
 * Adding more Hue instances behind the load balancer will increase performances by 50 concurrent users.
 * Database backend should be such as MySql/Postgres/Oracle. Hue does not work on SQLite as it makes concurrent calls to the database.
 * Check the number of documents in the Hue database. If they are too many (more than 100 000), delete the old records:
-  Stop the Hue service. Log on to the host of your Hue server. Go to Hue directory and run following clean up [command]({{% param baseURL %}}administrator/administration/operations/#commands):
+  Stop the Hue service. Log on to the host of your Hue server. Go to Hue directory and run following clean up [command](/administrator/administration/operations/#commands):
 <pre>
     cd /opt/cloudera/parcels/CDH/lib/hue # Hue home directory
     ./build/env/bin/hue desktop_document_cleanup
@@ -32,7 +32,7 @@ In practice ~50 users / Hue peak time is the rule of thumb. This is accounting f
 
 * There are some memory fragmentation issues in Python that manifest in Hue. Check the memory usage of Hue periodically. Browsing HDFS dir with many files, downloading a query result, copying a HDFS files are costly operations memory wise.
 
-The [Config Check]({{% param baseURL %}}administrator/administration/reference/) page of Hue (`/hue/about/`) in the administrator section will warn about detected risks. Make sure it is at zero.
+The [Config Check](/administrator/administration/reference/) page of Hue (`/hue/about/`) in the administrator section will warn about detected risks. Make sure it is at zero.
 
 Hue comes with caching of SQL metadata throughout all the application, meaning the list of tables or a database or the column description of a table are only fetched once and re-used in the autocomplete, table browser, left and right panels etc.. The profiling of calls adds in the logs with a total time taken by each request automatically logged.
 

+ 1 - 1
docs/docs-site/content/administrator/configuration/_index.md

@@ -17,4 +17,4 @@ The most important things to configure are:
 
 ## Services to interact with
 
-Sometimes some Hadoop components need to be configured to properly work with Hue. Hue is using Hadoop `impersonation` to be able to communicate properly with certain services. This is described in the following [Service Configuration]({{% param baseURL %}}administrator/configuration/).
+Sometimes some Hadoop components need to be configured to properly work with Hue. Hue is using Hadoop `impersonation` to be able to communicate properly with certain services. This is described in the following [Service Configuration](/administrator/configuration/).

+ 4 - 4
docs/docs-site/content/administrator/configuration/editor/_index.md

@@ -6,7 +6,7 @@ weight: 2
 ---
 
 The goal of the Editor is to open-up data to more users by making self service querying easy and productive.
-It has one of the best SQL autocomplete and many [more features]({{% param baseURL %}}administrator/configuration/editor/).
+It has one of the best SQL autocomplete and many [more features](/administrator/configuration/editor/).
 
 It is available in Editor or Notebook. Dialects can be added to the main `[notebook]` section like this:
 
@@ -97,7 +97,7 @@ Display an analysis panel post Impala queries executions with some hints and sug
 
 ### Query Optimization
 
-In the `[metadata]` section, Hue is supporting Cloudera Navigator Optimiser and soon other services. The goal is to provide recommendation on how to write better queries and get risk alerts on dangerous operations directly within the [editor]({{% param baseURL %}}user/editor/).
+In the `[metadata]` section, Hue is supporting Cloudera Navigator Optimiser and soon other services. The goal is to provide recommendation on how to write better queries and get risk alerts on dangerous operations directly within the [editor](/user/editor/).
 
 ### One-click scheduling
 
@@ -245,7 +245,7 @@ Direct interface:
       interface=presto
       ## Specific options for connecting to the Presto server.
       ## To connect to Presto over HTTPS/SSL you will need to construct connection string like below:
-      ## "url": "jdbc:presto://localhost:8080/catalog/schema?SSL=true&SSLTrustStorePath=/path/to/key_file&SSLTrustStorePassword=${password}"   
+      ## "url": "jdbc:presto://localhost:8080/catalog/schema?SSL=true&SSLTrustStorePath=/path/to/key_file&SSLTrustStorePassword=${password}"
       ## The JDBC driver presto-jdbc.jar need to be in the CLASSPATH environment variable.
       ## If 'user' and 'password' are omitted, they will be prompted in the UI.
       options='{"url": "jdbc:presto://localhost:8080/catalog/schema", "driver": "io.prestosql.jdbc.PrestoDriver", "user": "root", "password": "root"}'
@@ -854,7 +854,7 @@ Then make sure the `hive` interpreter is present in the `[[interpreters]]` list.
 
 ### Custom
 
-A series of native connectors interacting with the editor have been developed and are listed in the [developer section]({{% param baseURL %}}developer/editor/).
+A series of native connectors interacting with the editor have been developed and are listed in the [developer section](/developer/editor/).
 
 ### JDBC
 

+ 1 - 1
docs/docs-site/content/administrator/configuration/external/_index.md

@@ -8,7 +8,7 @@ weight: 5
 
 ## Data Catalog
 
-In the `[metadata]` section, Hue is supporting Cloudera Navigator and soon Apache Atlas ([HUE-8749](https://issues.cloudera.org/browse/HUE-8749)) in order to enrich the [data catalog]({{% param baseURL %}}user/browsers/).
+In the `[metadata]` section, Hue is supporting Cloudera Navigator and soon Apache Atlas ([HUE-8749](https://issues.cloudera.org/browse/HUE-8749)) in order to enrich the [data catalog](/user/browsers/).
 
 ## Spark
 

+ 2 - 2
docs/docs-site/content/administrator/configuration/files/_index.md

@@ -72,7 +72,7 @@ If the configuration is not present, add it to /etc/hadoop/conf/core-site.xml an
 
 Hue's filebrowser can now allow users to explore, manage, and upload data in an S3 account, in addition to HDFS.
 
-Read more about it in the [S3 User Documentation]({{% param baseURL %}}user/browsers#s3).
+Read more about it in the [S3 User Documentation](/user/browsers#s3).
 
 In order to add an S3 account to Hue, you'll need to configure Hue with valid S3 credentials, including the access key ID and secret access key: [AWSCredentials](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSGettingStartedGuide/AWSCredentials.html)
 
@@ -109,7 +109,7 @@ New end points have been added in [HUE-5420](https://issues.cloudera.org/browse/
 
 Hue's file browser can now allow users to explore, manage, and upload data in an ADLS v1 or ADLS v2 (ABFS), in addition to HDFS and S3. ABFS is currently a work in progress with [HUE-8908](https://issues.cloudera.org/browse/HUE-8908)
 
-Read more about it in the [ADLS User Documentation]({{% param baseURL %}}user/browsers#adls).
+Read more about it in the [ADLS User Documentation](/user/browsers#adls).
 
 In order to add an ADLS account to Hue, you'll need to configure Hue with valid ADLS credentials, including the client ID, client secret and tenant ID.
 These keys can securely stored in a script that outputs the actual access key and secret key to stdout to be read by Hue (this is similar to how Hue reads password scripts). In order to use script files, add the following section to your hue.ini configuration file:

+ 3 - 3
docs/docs-site/content/administrator/configuration/server/_index.md

@@ -238,10 +238,10 @@ Note: When using direct bind, set LDAP Search Base, not for authentication (you
 
 #### Troubleshooting
 
-##### Issue: 
+##### Issue:
 Hue is not able to sync the LDAP group in Hue and it reports the following error : Could not get LDAP details for groups in pattern <group_name>
 
-##### Solution: 
+##### Solution:
 check your configuration if 'subgroups' is set under [[ldap]] and remove it.
 
 
@@ -655,7 +655,7 @@ Read more about it in [Hue with a custom logo](http://gethue.com/hue-with-a-cust
 
 ## Source Version Control
 
-By default Hue stores the [saved documents]({{% param baseURL %}}user/concept/#documents) in its database. This features aims at pointing to any source versioning systems like GitHub, BitBucket... to open and save queries.
+By default Hue stores the [saved documents](/user/concept/#documents) in its database. This features aims at pointing to any source versioning systems like GitHub, BitBucket... to open and save queries.
 
 **Note** This feature is experiemental and tracked in [HUE-951](https://issues.cloudera.org/browse/HUE-951).
 

+ 1 - 1
docs/docs-site/content/administrator/installation/_index.md

@@ -7,7 +7,7 @@ weight: 1
 
 ## Quick Start
 
-Follow the [Quick Start](https://github.com/cloudera/hue#getting-started) or [Container]({{% param baseURL %}}administrator/installation/containers/) guides.
+Follow the [Quick Start](https://github.com/cloudera/hue#getting-started) or [Container](/administrator/installation/containers/) guides.
 
 
 ## Installation

+ 1 - 1
docs/docs-site/content/administrator/installation/cloud.md

@@ -95,7 +95,7 @@ Next step: in addition to Elastic Search, the logs can also be automatically sto
 
 ### Metrics
 
-Hue [metrics]({{% param baseURL %}}administrator/administration/operations#metrics) are useful for checking the load (how many users), slowness (average or percentile times taken by requests)... Those have been available via the /metrics page, but here is how to collect and aggregate this information in Kubernetes.
+Hue [metrics](/administrator/administration/operations#metrics) are useful for checking the load (how many users), slowness (average or percentile times taken by requests)... Those have been available via the /metrics page, but here is how to collect and aggregate this information in Kubernetes.
 
 Prometheus is the metric collecting system heavily used in the Kubernetes world.
 

+ 1 - 1
docs/docs-site/content/administrator/installation/install.md

@@ -5,7 +5,7 @@ draft: false
 weight: 2
 ---
 
-Start from a [release]({{% param baseURL %}}releases/) tarball or [building](https://github.com/cloudera/hue#getting-started) the project yourself.
+Start from a [release](/releases/) tarball or [building](https://github.com/cloudera/hue#getting-started) the project yourself.
 
 Then configure `$PREFIX` with the path where you want to install Hue by running:
 

+ 2 - 2
docs/docs-site/content/administrator/installation/starting.md

@@ -14,8 +14,8 @@ components. Your Hue installation is now running.
 
 After installation, you can use Hue by navigating to `http://myserver:8888/`.
 
-Next step is to [configure]({{% param baseURL %}}administrator/configuration/) Hue to point to the external services.
-Then, the [user guide]({{% param baseURL %}}user/index.html) will help users go through the various installed applications.
+Next step is to [configure](/administrator/configuration/) Hue to point to the external services.
+Then, the [user guide](/user/index.html) will help users go through the various installed applications.
 
 
 **Supported Browsers**

+ 13 - 13
docs/docs-site/content/developer/development/_index.md

@@ -12,7 +12,7 @@ This section goes into greater detail on how to build and reuse the components o
 
 ### Dependencies
 
-* The OS specific install instructions are listed in the [install guide]({{% param baseURL %}}administrator/installation/dependencies/)
+* The OS specific install instructions are listed in the [install guide](/administrator/installation/dependencies/)
 * Python 2.7+ (Python 3 support tracked in [HUE-8737](https://issues.cloudera.org/browse/HUE-8737))
 * Django (1.11 already included in the distribution)
 * Java (Java 1.8) (should go away after [HUE-8740](https://issues.cloudera.org/browse/HUE-8740))
@@ -71,7 +71,7 @@ Note: code updates won’t be seen after the Docker container runs. For this Hue
 
     ./build/env/bin/hue runserver 0.0.0.0:8888
 
-and recompiling the Docker image. It will then auto-restart on Python code changes. For JavaScript, those would need to be [compiled]({{% param baseURL %}}/developer/development/#javascript).
+and recompiling the Docker image. It will then auto-restart on Python code changes. For JavaScript, those would need to be [compiled](//developer/development/#javascript).
 
 ### Javascript
 
@@ -188,27 +188,27 @@ Recommended extensions:
 #### PyCharm
 
 First step is to configure pycharm to use the Hue virtual environment at ./build/env/env
-![Pycharm virtualenv]({{% param baseURL %}}images/pycharm_virtualenv.png)
+![Pycharm virtualenv](/images/pycharm_virtualenv.png)
 
 Second step is to configure the debug configuration
-![Pycharm debug]({{% param baseURL %}}images/pycharm_debug.png)
+![Pycharm debug](/images/pycharm_debug.png)
 
 #### Eclipse
 
 First step is to configure Eclipse to use the Hue virtual environment at ./build/env/env
-![Eclipse interpreter]({{% param baseURL %}}images/eclipse_interpreter.png)
+![Eclipse interpreter](/images/eclipse_interpreter.png)
 
 Second step is to configure the debug configuration
-![Eclipse debug]({{% param baseURL %}}images/eclipse_debug.png)
-![Eclipse debug arguments]({{% param baseURL %}}images/eclipse_debug_arguments.png)
-![Eclipse debug interpreter]({{% param baseURL %}}images/eclipse_debug_interpreter.png)
+![Eclipse debug](/images/eclipse_debug.png)
+![Eclipse debug arguments](/images/eclipse_debug_arguments.png)
+![Eclipse debug interpreter](/images/eclipse_debug_interpreter.png)
 
 
 ## API Server
 
 ### From 30,000 feet
 
-![From up on high]({{% param baseURL %}}images/from30kfeet.png)
+![From up on high](/images/from30kfeet.png)
 
 Hue, as a "container" web application, sits in between your Hadoop installation
 and the browser.  It hosts all the Hue Apps, including the built-in ones, and
@@ -216,7 +216,7 @@ ones that you may write yourself.
 
 ### The Hue Server
 
-![Web Back-end]({{% param baseURL %}}images/webbackend.png)
+![Web Back-end](/images/webbackend.png)
 
 Hue is a web application built on the Django python web framework.
 Django, running on the WSGI container/web server (typically CherryPy), manages
@@ -231,14 +231,14 @@ daemon processes "on the side". Some examples are the `Celery Task Server`, `Cel
 
 ### Interacting with external services
 
-![Interacting with Hadoop]({{% param baseURL %}}images/interactingwithhadoop.png)
+![Interacting with Hadoop](/images/interactingwithhadoop.png)
 
 Hue provides some APIs for interacting with external services like Databases of File storages.
 These APIs work by making REST or Thrift calls.
 
 ### An Architectural View
 
-![Architecture]({{% param baseURL %}}images/architecture.png)
+![Architecture](/images/architecture.png)
 
 A Hue application may span three tiers: (1) the UI
 and user interaction in the client's browser, (2) the
@@ -395,7 +395,7 @@ are Django's Object-Relational Mapping framework.
 
 ### Walk-through of a Django View
 
-![Django Request]({{% param baseURL %}}images/django_request.png)
+![Django Request](/images/django_request.png)
 
 
 Django is an MVC framework, except that the controller is called a

+ 2 - 2
docs/docs-site/content/developer/editor/_index.md

@@ -13,11 +13,11 @@ Connectors are pluggable and can new engines can be supported. Feel free to comm
 
 ## SQL
 
-The [Editor Configuration]({{% param baseURL %}}administrator/configuration/editor/) also describes the configuration steps.
+The [Editor Configuration](/administrator/configuration/editor/) also describes the configuration steps.
 
 Close to 100% of [Hive and Impala grammar](https://github.com/cloudera/hue/blob/master/desktop/core/src/desktop/static/desktop/js/autocomplete/jison) is supported which makes the autocomplete extremly powerful. Other languages defaults to a generic SQL grammar.
 
-See [How to write your own SQL parser]({{% param baseURL %}}developer/parsers/). Integrating [Apache Calcite](https://calcite.apache.org/docs/reference.html), [ZetaSql](https://github.com/google/zetasql)... would make SQL users even happier with a lot more Databases!
+See [How to write your own SQL parser](/developer/parsers/). Integrating [Apache Calcite](https://calcite.apache.org/docs/reference.html), [ZetaSql](https://github.com/google/zetasql)... would make SQL users even happier with a lot more Databases!
 
 ### HiveServer2 API
 Hive, Impala, SparkSQL

+ 1 - 1
docs/docs-site/content/developer/parsers/_index.md

@@ -101,7 +101,7 @@ So if a “lonely” cursor is encountered it will tell us to suggest the ‘SEL
 
 ### Prerequisites
 
-Make sure you have [jison]({{% param baseURL %}}developer/development/#sql-autocomplete) installed and a [development]({{% param baseURL %}}administrator/installation/dependencies/) Hue. Then configure a [PostgreSQL interpreter]({{% param baseURL %}}administrator/configuration/editor/#postgresql).
+Make sure you have [jison](/developer/development/#sql-autocomplete) installed and a [development](/administrator/installation/dependencies/) Hue. Then configure a [PostgreSQL interpreter](/administrator/configuration/editor/#postgresql).
 
 In the Hue folder:
 

+ 1 - 1
docs/docs-site/content/quickstart/_index.md

@@ -5,7 +5,7 @@ draft: false
 weight: 1
 ---
 
-Open-up or install Hue then [configure it]({{% param baseURL %}}administrator/configuration/).
+Open-up or install Hue then [configure it](/administrator/configuration/).
 
 ## Demo
 

+ 1 - 1
docs/docs-site/content/user/browsers/_index.md

@@ -13,7 +13,7 @@ The browsers can be "enriched" with [Search and Tagging](http://gethue.com/impro
 
 The Table Browser enables you to manage the databases, tables, and partitions of the metastore shared by the Hive and Impala. You can perform the following operations:
 
--   Search and display metadata like tags and additional description from [Catalog backends]({{% param baseURL %}}administrator/configuration/external/).
+-   Search and display metadata like tags and additional description from [Catalog backends](/administrator/configuration/external/).
 
 -   Databases
     -   Select a database

+ 1 - 1
docs/docs-site/content/user/concept/_index.md

@@ -31,7 +31,7 @@ Each app of Hue can be extended to support your own languages or apps as detaile
 
 The layout simplifies the interface and is a snappy single page app.
 
-![image]({{% param baseURL %}}images/hue-4-interface-concept.png)
+![image](/images/hue-4-interface-concept.png)
 
 From top to bottom we have:
 

+ 2 - 2
docs/docs-site/content/user/editor/_index.md

@@ -11,7 +11,7 @@ It focuses on SQL but also supports job submissions. It comes with an intelligen
 
 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]({{% param baseURL %}}administrator/configuration/editor/).
+Configuration of the connectors is currently done by the [Administrator](/administrator/configuration/editor/).
 
 ## Concepts
 ### Running Queries
@@ -162,7 +162,7 @@ Turns a list of semi-colon separated queries into an interactive presentation. I
 
 ## SQL Databases
 
-Use the query editor with any database. Those databases need to be configured by the [administratior]({{% param baseURL %}}administrator/configuration/editor/)
+Use the query editor with any database. Those databases need to be configured by the [administratior](/administrator/configuration/editor/)
 
 ### Apache Hive
 ### Apache Impala

+ 1 - 1
docs/docs-site/layouts/partials/favicon.html

@@ -1 +1 @@
-<link rel="shortcut icon" href="{{ .Site.Params.baseURL }}images/favicon.png" type="image/x-icon" />
+<link rel="shortcut icon" href="/images/favicon.png" type="image/x-icon" />

+ 1 - 1
docs/docs-site/layouts/partials/logo.html

@@ -1,3 +1,3 @@
 <a href="http://gethue.com">
-  <img src="{{ .Site.Params.baseURL }}images/hue_logo.png" alt="alt text" title="Hue Logo">
+  <img src="/images/hue_logo.png" alt="alt text" title="Hue Logo">
 </a>