Skip to content

Commit

Permalink
updated EdgeSet manual (en-US)
Browse files Browse the repository at this point in the history
  • Loading branch information
Tetmon CD committed Feb 2, 2025
1 parent a37a68b commit 6ad926b
Show file tree
Hide file tree
Showing 19 changed files with 161 additions and 52 deletions.
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 @@ -253,7 +253,7 @@ <h1 class="title"><span class="chapter-title"> Catalog</span></h1>
<figcaption>The catalog sidebar showing the always-available system data source.</figcaption>
</figure>
</div>
<p>The catalog is a tree view of all data sources. Tables in each data source are arranged in schemas.</p>
<p>The catalog is a tree view of all &nbsp;data sources. &nbsp;Tables in each data source are arranged in &nbsp;folders.</p>
<p>For SQL data sources, these schemas and tables will correspond to those in the data source. For other non-SQL data sources, the schemas and table names will vary, based on how the data has been mapped by EdgeSet.</p>
<section id="exploring-tables" class="level2">
<h2 class="anchored" data-anchor-id="exploring-tables">Exploring tables</h2>
Expand Down
4 changes: 2 additions & 2 deletions public/edgeset/manual/current/en-US/index.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">

<meta name="author" content="Tetmon Pte. Ltd.">
<meta name="dcterms.date" content="2024-12-25">
<meta name="dcterms.date" content="2025-02-02">

<title>EdgeSet Manual</title>
<style>
Expand Down Expand Up @@ -248,7 +248,7 @@ <h1 class="title">EdgeSet Manual</h1>
<div>
<div class="quarto-title-meta-heading">Published</div>
<div class="quarto-title-meta-contents">
<p class="date">December 25, 2024</p>
<p class="date">February 2, 2025</p>
</div>
</div>

Expand Down
201 changes: 155 additions & 46 deletions public/edgeset/manual/current/en-US/installation.html

Large diffs are not rendered by default.

Binary file modified public/edgeset/manual/current/en-US/screenshots/add-group.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified public/edgeset/manual/current/en-US/screenshots/admin-backups.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified public/edgeset/manual/current/en-US/screenshots/export-menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified public/edgeset/manual/current/en-US/screenshots/lets-encrypt.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified public/edgeset/manual/current/en-US/screenshots/query-result.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified public/edgeset/manual/current/en-US/screenshots/settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified public/edgeset/manual/current/en-US/screenshots/setup-form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified public/edgeset/manual/current/en-US/screenshots/ssh-login.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions public/edgeset/manual/current/en-US/search.json
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@
"href": "installation.html#desktop-application",
"title": " Installation",
"section": "",
"text": "Requirements\n\nmacOS 13+1\n12GB of free disk space\nEdgeSet license key\ninternet connection\n\n1 The desktop application is tested on Apple Silicon Macs only, not Intel Macs.\n\nInstallation\n\nDownload EdgeSet from https://www.tetmon.com/EdgeSet.dmg.\nOpen your Downloads folder and double-click the EdgeSet.dmg file. \nDrag the EdgeSet icon to the Applications folder. \nOpen the EdgeSet application from the Applications folder. \nWhen you first start EdgeSet, you might see the following prompt. Click Open to proceed. \nDuring installation and whenever you launch EdgeSet, you might be prompted to allow EdgeSet access to the keychain. EdgeSet will only access data that it stores on the keychain itself. Select Always Allow.2 \nEdgeSet will begin downloading the query engine. This is a one-time setup. \nOnce the query engine download is complete, EdgeSet will start up. \nThe first time EdgeSet starts, it will prompt you for your license key. \nClick Upload license file… and Open the license.key file you were provided. \nEdgeSet will show a brief loading screen with progress indicator while it generates an encryption key. Then the EdgeSet interface will appear and you are ready to begin adding data sources. \n\n2 EdgeSet uses the macOS keychain to store credentials in order to protect your data from other applications on the system.\n\nUninstallation\n\nTo uninstall EdgeSet, move the EdgeSet Application to the Trash. \nOpen the ~/Library/Application Support folder and move the EdgeSet folder there into the Trash (this is the folder that holds the query engine).3 \n\n3 To easily navigate to the Application Support folder from the Finder, you can press ⌘Command + Shift + G and type in ~/Library/Application Support.",
"text": "Requirements\n\nmacOS 13+1\n12GB of free disk space\nEdgeSet license key\ninternet connection\n\n1 The desktop application is tested on Apple Silicon Macs only, not Intel Macs.\n\nInstallation\n\nDownload EdgeSet from https://www.tetmon.com/EdgeSet.dmg.\nOpen your Downloads folder and double-click the EdgeSet.dmg file.\n\n\n\n\nthe EdgeSet.dmg file in the Downloads folder\n\n\n\nDrag the EdgeSet icon to the Applications folder.\n\n\n\n\nthe EdgeSet installation folder\n\n\n\nOpen the EdgeSet application from the Applications folder.\n\n\n\n\nEdgeSet in the Applications folder\n\n\n\nWhen you first start EdgeSet, you might see the following prompt. Click Open to proceed.\n\n\n\n\nmacOS prompt that EdgeSet has been downloaded from the internet\n\n\n\nDuring installation and whenever you launch EdgeSet, you might be prompted to allow EdgeSet access to the keychain. EdgeSet will only access data that it stores on the keychain itself. Select Always Allow.2\n\n2 EdgeSet uses the macOS keychain to store credentials in order to protect your data from other applications on the system.\n\n\nmacOS keychain prompt\n\n\n\nEdgeSet will begin downloading the query engine. This is a one-time setup.\n\n\n\n\nEdgeSet query engine download progress\n\n\n\nOnce the query engine download is complete, EdgeSet will start up.\n\n\n\n\nEdgeSet startup message\n\n\n\nThe first time EdgeSet starts, it will prompt you for your license key.\n\n\n\n\nEdgeSet upload license key dialog\n\n\n\nClick Upload license file… and Open the license.key file you were provided.\n\n\n\n\nbrowse to EdgeSet license key\n\n\n\nEdgeSet will show a brief loading screen with progress indicator while it generates an encryption key. Then the EdgeSet interface will appear and you are ready to begin adding data sources.\n\n\n\n\nthe EdgeSet interface\n\n\n\n\nUninstallation\n\nTo uninstall EdgeSet, move the EdgeSet Application to the Trash.\n\n\n\n\nmove the EdgeSet Application to the Trash\n\n\n\nOpen the ~/Library/Application Support folder and move the EdgeSet folder there into the Trash (this is the folder that holds the query engine).3\n\n3 To easily navigate to the Application Support folder from the Finder, you can press ⌘Command + Shift + G and type in ~/Library/Application Support.\n\n\nmove the EdgeSet Application Support folder to the Trash",
"crumbs": [
"<span class='chapter-number'>2</span>  <span class='chapter-title'> Installation</span>"
]
Expand All @@ -84,7 +84,7 @@
"href": "installation.html#web-application",
"title": " Installation",
"section": "Web Application",
"text": "Web Application\n\nRequirements\nEdgeSet is designed to run on-premise or in a private cloud. You can install it on a physical server (“bare metal”) or a VM (such as from AWS, Azure, Digital Ocean, etc.).\nEdgeSet requires a 64-bit Intel-compatible (x86-64) or ARM64 (aarch64) CPU.\n\nMinimum system requirements\n\n\nConcurrent query slots\nMemory\nCPU Cores\nDisk\n\n\n\n\n2\n8GB\n2\n16GB\n\n\n5\n12GB\n4\n20GB\n\n\n15\n24GB\n12\n30GB\n\n\n50\n64GB\n32\n60GB\n\n\n\nEdgeSet also requires UEFI support.4\n4 Most computers since 2006 have UEFI support.\n\nAWS\nLaunch an EC2 instance using the EdgeSet AMI ID provided to you.\n\n\nDigital Ocean\nImport the provided EdgeSet qcow disk image (x86_64 or arm64) to your DigitalOcean account as a “Custom Image” (see https://www.digitalocean.com/blog/custom-images/). Launch a droplet with the custom image.\n\n\nContabo\nImport the provided EdgeSet qcow2 disk image (x86_64 or arm64) to your Contabo account as a “Custom Image” (see https://docs.contabo.com/docs/products/Cloud-VPS-and-VDS/Tutorial/custom-images/). Launch a VPS with the image.\n\n\nPhysical hardware\nWrite the raw disk image (x86_64 or arm64) to the boot hard drive.\n\n\nUnattended Installer ISO\nYou can install EdgeSet on physical hardware and most VMs via the unattended installer ISO.\n\n\n\n\n\n\nWarning\n\n\n\nThe unattended installer ISO will automatically partition the first connected hard drive of any machine it boots on.",
"text": "Web Application\n\nRequirements\nEdgeSet is designed to run on-premise or in a private cloud. You can install it on a physical server (“bare metal”) or a VM (such as from AWS, Azure, Digital Ocean, etc.).\nEdgeSet requires a 64-bit Intel-compatible (x86-64) or ARM64 (aarch64) CPU.\n\nMinimum system requirements\n\n\nConcurrent query slots\nMemory\nCPU Cores\nDisk\n\n\n\n\n2\n8GB\n2\n16GB\n\n\n5\n12GB\n4\n20GB\n\n\n15\n24GB\n12\n30GB\n\n\n50\n64GB\n32\n60GB\n\n\n\nEdgeSet also requires UEFI support.4\n4 Most computers since 2006 have UEFI support.\n\nAmazon Web Services (AWS)\nLaunch an EC2 instance using the EdgeSet AMI ID provided to you.\n\n\nGoogle Cloud Platform (GCP)\nLaunch a GCE instance using the qcow2 disk image (x86_64 or arm64).\n\n\nDigital Ocean\nImport the qcow2 disk image (x86_64 or arm64) to your DigitalOcean account as a “Custom Image” (see https://www.digitalocean.com/blog/custom-images/). Launch a droplet with the custom image.\n\n\nHetzner Cloud\nImport the raw disk image (x86_64 or arm64) as a snapshot (i.e. using hcloud-upload-image). Launch a new VM with the snapshot.",
"crumbs": [
"<span class='chapter-number'>2</span>  <span class='chapter-title'> Installation</span>"
]
Expand Down Expand Up @@ -204,7 +204,7 @@
"href": "catalog.html",
"title": " Catalog",
"section": "",
"text": "Exploring tables\nAt any time, you can click the Catalog tab to open and close the catalog sidebar.\nThe catalog is a tree view of all data sources. Tables in each data source are arranged in schemas.\nFor SQL data sources, these schemas and tables will correspond to those in the data source. For other non-SQL data sources, the schemas and table names will vary, based on how the data has been mapped by EdgeSet.\nClick the “play” icon next to a table to explore it in the query notebook.",
"text": "Exploring tables\nAt any time, you can click the Catalog tab to open and close the catalog sidebar.\nThe catalog is a tree view of all  data sources.  Tables in each data source are arranged in  folders.\nFor SQL data sources, these schemas and tables will correspond to those in the data source. For other non-SQL data sources, the schemas and table names will vary, based on how the data has been mapped by EdgeSet.\nClick the “play” icon next to a table to explore it in the query notebook.",
"crumbs": [
"<span class='chapter-number'>6</span>  <span class='chapter-title'> Catalog</span>"
]
Expand Down

0 comments on commit 6ad926b

Please sign in to comment.