Skip to content

Commit

Permalink
updated EdgeSet manual
Browse files Browse the repository at this point in the history
  • Loading branch information
Tetmon CD committed Mar 5, 2024
1 parent 3152b75 commit ed792e3
Show file tree
Hide file tree
Showing 47 changed files with 295 additions and 186 deletions.
4 changes: 2 additions & 2 deletions public/edgeset/manual/current/en-US/FAQ.html
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="./data-sources.html" class="sidebar-item-text sidebar-link">
<span class="menu-text"><span class="chapter-number">4</span>&nbsp; <span class="chapter-title">Data Sources</span></span></a>
<span class="menu-text"><span class="chapter-number">4</span>&nbsp; <span class="chapter-title">Connect Data Sources</span></span></a>
</div>
</li>
<li class="sidebar-item">
Expand Down Expand Up @@ -238,7 +238,7 @@ <h1 class="title">Appendix A — FAQ</h1>
<dd>
<p>Yes.</p>
</dd>
<dt>Does EdgeSet support CTEs?</dt>
<dt>Does EdgeSet support CTEs (Common Table Expressions)?</dt>
<dd>
<p>Yes.</p>
</dd>
Expand Down
2 changes: 1 addition & 1 deletion public/edgeset/manual/current/en-US/backups.html
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="./data-sources.html" class="sidebar-item-text sidebar-link">
<span class="menu-text"><span class="chapter-number">4</span>&nbsp; <span class="chapter-title">Data Sources</span></span></a>
<span class="menu-text"><span class="chapter-number">4</span>&nbsp; <span class="chapter-title">Connect Data Sources</span></span></a>
</div>
</li>
<li class="sidebar-item">
Expand Down
2 changes: 1 addition & 1 deletion public/edgeset/manual/current/en-US/catalog.html
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="./data-sources.html" class="sidebar-item-text sidebar-link">
<span class="menu-text"><span class="chapter-number">4</span>&nbsp; <span class="chapter-title">Data Sources</span></span></a>
<span class="menu-text"><span class="chapter-number">4</span>&nbsp; <span class="chapter-title">Connect Data Sources</span></span></a>
</div>
</li>
<li class="sidebar-item">
Expand Down
8 changes: 4 additions & 4 deletions public/edgeset/manual/current/en-US/clients.html
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="./data-sources.html" class="sidebar-item-text sidebar-link">
<span class="menu-text"><span class="chapter-number">4</span>&nbsp; <span class="chapter-title">Data Sources</span></span></a>
<span class="menu-text"><span class="chapter-number">4</span>&nbsp; <span class="chapter-title">Connect Data Sources</span></span></a>
</div>
</li>
<li class="sidebar-item">
Expand Down Expand Up @@ -241,17 +241,17 @@ <h1 class="title"><span class="chapter-number">10</span>&nbsp; <span class="chap

</header>

<p>EdgeSet provides a Presto-compatible interface for connecting to it from any compatible third-party tool or programming language. Navigate to the <code>Connect</code> menu to view a list of clients tested by EdgeSet engineers.</p>
<p>You can connect to EdgeSet from any tool or programming language that supports either the PostgreSQL protocol or the Presto API. Navigate to the <code>Connect</code> menu to view a list of clients tested by EdgeSet engineers.</p>
<div class="quarto-figure quarto-figure-center">
<figure class="figure">
<p><img src="screenshots/connect-dbeaver.png" class="img-fluid figure-img"></p>
<figcaption class="figure-caption">clicking on a listed client provides connection details</figcaption>
</figure>
</div>
<p>This list is not exhaustive and Presto protocol support is being added to new tools regularly.</p>
<p>This list is not exhaustive.</p>
<section id="authentication" class="level2" data-number="10.1">
<h2 data-number="10.1" class="anchored" data-anchor-id="authentication"><span class="header-section-number">10.1</span> Authentication</h2>
<p>Clients connect with the same username and password used for the EdgeSet web interface. All connections are over HTTPS, so neither passwords nor data are transmitted unencrypted.</p>
<p>Clients connect with the same username and password used for the EdgeSet web interface. All connections are encrypted, so neither passwords nor data are transmitted unencrypted.</p>
</section>
<section id="non-human-users" class="level2" data-number="10.2">
<h2 data-number="10.2" class="anchored" data-anchor-id="non-human-users"><span class="header-section-number">10.2</span> Non-human users</h2>
Expand Down
35 changes: 29 additions & 6 deletions public/edgeset/manual/current/en-US/data-sources.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">


<title>EdgeSet Manual - 4&nbsp; Data Sources</title>
<title>EdgeSet Manual - 4&nbsp; Connect Data Sources</title>
<style>
code{white-space: pre-wrap;}
span.smallcaps{font-variant: small-caps;}
Expand Down Expand Up @@ -74,7 +74,7 @@
<button type="button" class="quarto-btn-toggle btn" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar,#quarto-sidebar-glass" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
<i class="bi bi-layout-text-sidebar-reverse"></i>
</button>
<nav class="quarto-page-breadcrumbs" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="./data-sources.html"><span class="chapter-number">4</span>&nbsp; <span class="chapter-title">Data Sources</span></a></li></ol></nav>
<nav class="quarto-page-breadcrumbs" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="./data-sources.html"><span class="chapter-number">4</span>&nbsp; <span class="chapter-title">Connect Data Sources</span></a></li></ol></nav>
<a class="flex-grow-1" role="button" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar,#quarto-sidebar-glass" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
</a>
<button type="button" class="btn quarto-search-button" aria-label="" onclick="window.quartoOpenSearch();">
Expand Down Expand Up @@ -126,7 +126,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="./data-sources.html" class="sidebar-item-text sidebar-link active">
<span class="menu-text"><span class="chapter-number">4</span>&nbsp; <span class="chapter-title">Data Sources</span></span></a>
<span class="menu-text"><span class="chapter-number">4</span>&nbsp; <span class="chapter-title">Connect Data Sources</span></span></a>
</div>
</li>
<li class="sidebar-item">
Expand Down Expand Up @@ -226,7 +226,7 @@ <h2 id="toc-title">Table of contents</h2>

<header id="title-block-header" class="quarto-title-block default">
<div class="quarto-title">
<h1 class="title"><span class="chapter-number">4</span>&nbsp; <span class="chapter-title">Data Sources</span></h1>
<h1 class="title"><span class="chapter-number">4</span>&nbsp; <span class="chapter-title">Connect Data Sources</span></h1>
</div>


Expand All @@ -241,7 +241,7 @@ <h1 class="title"><span class="chapter-number">4</span>&nbsp; <span class="chapt

</header>

<p>To add a data source to EdgeSet, first navigate to “Data Sources” in the menu. Available data sources are listed on the “Add New Data Source” card.</p>
<p>To connect to a data source in EdgeSet, first navigate to “Connect” in the navigation bar. Available data sources are listed on the “Add new data source” card.</p>
<p>You can add any number of each data source type. For example, you can add multiple PostgreSQL databases.</p>
<section id="google-sheets" class="level2" data-number="4.1">
<h2 data-number="4.1" class="anchored" data-anchor-id="google-sheets"><span class="header-section-number">4.1</span> Google Sheets</h2>
Expand Down Expand Up @@ -300,15 +300,25 @@ <h2 data-number="4.2" class="anchored" data-anchor-id="supported-data-source-ver
<td style="text-align: left;">unauthenticated only</td>
</tr>
<tr class="even">
<td style="text-align: left;">MariaDB</td>
<td style="text-align: left;">10.0 or higher</td>
<td style="text-align: left;">add as MySQL</td>
</tr>
<tr class="odd">
<td style="text-align: left;">MongoDB</td>
<td style="text-align: left;">4.0 or higher</td>
<td style="text-align: left;"></td>
</tr>
<tr class="odd">
<tr class="even">
<td style="text-align: left;">MySQL</td>
<td style="text-align: left;">5.7 or higher</td>
<td style="text-align: left;"></td>
</tr>
<tr class="odd">
<td style="text-align: left;">Oracle</td>
<td style="text-align: left;">11g or higher</td>
<td style="text-align: left;"></td>
</tr>
<tr class="even">
<td style="text-align: left;">PostgreSQL</td>
<td style="text-align: left;">10.0 or higher</td>
Expand All @@ -321,6 +331,19 @@ <h2 data-number="4.2" class="anchored" data-anchor-id="supported-data-source-ver
</tr>
</tbody>
</table>
<div class="callout callout-style-default callout-tip callout-titled">
<div class="callout-header d-flex align-content-center">
<div class="callout-icon-container">
<i class="callout-icon"></i>
</div>
<div class="callout-title-container flex-fill">
TPC-DS
</div>
</div>
<div class="callout-body-container callout-body">
<p>The TPC-DS data source is a built-in data source that can be used for testing. We will use it for illustration throughout the rest of the manual.</p>
</div>
</div>


</section>
Expand Down
51 changes: 27 additions & 24 deletions public/edgeset/manual/current/en-US/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="./data-sources.html" class="sidebar-item-text sidebar-link">
<span class="menu-text"><span class="chapter-number">4</span>&nbsp; <span class="chapter-title">Data Sources</span></span></a>
<span class="menu-text"><span class="chapter-number">4</span>&nbsp; <span class="chapter-title">Connect Data Sources</span></span></a>
</div>
</li>
<li class="sidebar-item">
Expand Down Expand Up @@ -217,7 +217,11 @@
<h2 id="toc-title">Table of contents</h2>

<ul>
<li><a href="#preface" id="toc-preface" class="nav-link active" data-scroll-target="#preface">Preface</a></li>
<li><a href="#preface" id="toc-preface" class="nav-link active" data-scroll-target="#preface">Preface</a>
<ul class="collapse">
<li><a href="#about-this-manual" id="toc-about-this-manual" class="nav-link" data-scroll-target="#about-this-manual">About this manual</a></li>
<li><a href="#intended-audience" id="toc-intended-audience" class="nav-link" data-scroll-target="#intended-audience">Intended audience</a></li>
</ul></li>
</ul>
</nav>
</div>
Expand Down Expand Up @@ -258,38 +262,37 @@ <h1 class="unnumbered">Preface</h1>
<p>Welcome to the community of data-driven organizations.</p>
<p><strong>As easy to use as a Data Science notebook.</strong> EdgeSet uses a simple and familiar notebook interface inspired by popular data science and analysis tools. Connecting to a data source is as simple as filling in the connection details. You can use the same SQL dialect to query any data source—even if the data source isn’t a SQL database.</p>
<p><strong>As powerful as a Big Data cluster.</strong> EdgeSet can connect to any number of data sources and combine data from these sources in a single query. By pushing queries down to the sources, EdgeSet turns your scattered data sources into a distributed parallel data processing fabric.</p>
<section id="about-this-manual" class="level2 unnumbered unlisted">
<h2 class="unnumbered unlisted anchored" data-anchor-id="about-this-manual">About this manual</h2>
<p>This manual will guide you through every step of setting up and using EdgeSet as a comprehensive and secure virtual data warehouse.</p>
<section id="about-this-manual" class="level2">
<h2 class="anchored" data-anchor-id="about-this-manual">About this manual</h2>
<p>This manual will guide you through every step of setting up and using EdgeSet as a comprehensive and secure virtual data warehouse and business intelligence tool.</p>
<p>It’s organized into chapters ordered to first acquaint you with how EdgeSet operates and then explain how to onboard the rest of the users in your organization.</p>
<p>The first 7 chapters will get you started connecting to different data sources and running queries.</p>
<p>The first 7 chapters will get you started connecting to different data sources and analyzing data.</p>
<ul>
<li>Chapter 1, “Introduction</li>
<li>Chapter 2, “Installation</li>
<li>Chapter 3, “Setup</li>
<li>Chapter 4, “Data Sources</li>
<li>Chapter 5, “Query Engine</li>
<li>Chapter 6, “Catalog</li>
<li>Chapter 7, “Query Notebook</li>
<li><a href="./introduction.html">Chapter 1: Introduction</a></li>
<li><a href="./installation.html">Chapter 2: Installation</a></li>
<li><a href="./setup.html">Chapter 3: Setup</a></li>
<li><a href="./data-sources.html">Chapter 4: Data Sources</a></li>
<li><a href="./query-engine.html">Chapter 5: Query Engine</a></li>
<li><a href="./catalog.html">Chapter 6: Catalog</a></li>
<li><a href="./query-notebook.html">Chapter 7: Query Notebook</a></li>
</ul>
<p>The next 6 chapters will help you roll out access to the rest of your company and ensure that your data remains protected.</p>
<ul>
<li>Chapter 8, “Users and Groups</li>
<li>Chapter 9, “Permissions</li>
<li>Chapter 10, “Clients</li>
<li>Chapter 11, “Security</li>
<li>Chapter 12, “Backups</li>
<li>Chapter 13, “Scaling</li>
<li><a href="./users-and-groups.html">Chapter 8: Users and Groups</a></li>
<li><a href="./permissions.html">Chapter 9: Permissions</a></li>
<li><a href="./clients.html">Chapter 10: Clients</a></li>
<li><a href="./security.html">Chapter 11: Security</a></li>
<li><a href="./backups.html">Chapter 12: Backups</a></li>
<li><a href="./scaling.html">Chapter 13: Scaling</a></li>
</ul>
<p>The final chapters explain some of the inner workings of EdgeSet’s distinctive features.</p>
<ul>
<li>Chapter 14, “Tabular Files</li>
<li><a href="./tabular-files.html">Chapter 14: Tabular Files</a></li>
</ul>
</section>
<section id="intended-audience" class="level2 unnumbered unlisted">
<h2 class="unnumbered unlisted anchored" data-anchor-id="intended-audience">Intended audience</h2>
<p>This manual is intended for EdgeSet administrators. Whether you are a DBA, sysadmin, DevOps, tech lead, analyst, or startup CEO, if you are the one who will setup and manage your EdgeSet instance, this manual is for you.</p>
<p>You should be familiar with SQL and should have administrator access to the data sources you intend to connect to.</p>
<section id="intended-audience" class="level2">
<h2 class="anchored" data-anchor-id="intended-audience">Intended audience</h2>
<p>This manual is intended for EdgeSet users and administrators. You should be familiar with SQL and should have access to the data sources you intend to connect to.</p>


</section>
Expand Down
Loading

0 comments on commit ed792e3

Please sign in to comment.