Skip to content

Commit

Permalink
docs: shorten install quick start, move rest to guide (meltano#6800)
Browse files Browse the repository at this point in the history
* add tabs plugin to docs with css etc.

* remove ws

* redo linking

* relink everything

* Update docs/src/_getting-started/installation.md

Co-authored-by: Will Da Silva <will@willdasilva.xyz>

Co-authored-by: Will Da Silva <will@willdasilva.xyz>
  • Loading branch information
sbalnojan and WillDaSilva committed Sep 29, 2022
1 parent e02c96f commit f0a396a
Show file tree
Hide file tree
Showing 13 changed files with 416 additions and 227 deletions.
1 change: 1 addition & 0 deletions docs/Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,5 @@ gem 'jekyll-redirect-from', "~>0.16"

group :jekyll_plugins do
gem 'jekyll-algolia'
gem "jekyll-tabs"
end
5 changes: 4 additions & 1 deletion docs/Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,8 @@ GEM
sassc (> 2.0.1, < 3.0)
jekyll-sitemap (1.4.0)
jekyll (>= 3.7, < 5.0)
jekyll-tabs (1.1.1)
jekyll (>= 3.0, < 5.0)
jekyll-toc (0.17.1)
jekyll (>= 3.9)
nokogiri (~> 1.11)
Expand Down Expand Up @@ -116,12 +118,13 @@ DEPENDENCIES
jekyll-algolia
jekyll-redirect-from (~> 0.16)
jekyll-sitemap (~> 1.4)
jekyll-tabs
jekyll-toc
tzinfo-data
webrick (~> 1.7)

RUBY VERSION
ruby 3.0.2p107
ruby 3.0.4p208

BUNDLED WITH
2.2.31
1 change: 1 addition & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ plugins:
- jekyll-sitemap
- jekyll-algolia
- jekyll-redirect-from
- jekyll-tabs

# Default plugin configuration
defaults:
Expand Down
1 change: 1 addition & 0 deletions docs/_includes/head.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
<link rel="stylesheet" type="text/css" href="/css/main.css">
<link rel="stylesheet" type="text/css" href="/css/docs.css">
<link rel="stylesheet" type="text/css" href="/css/termynal.css">
<link rel="stylesheet" type="text/css" href="/css/tabs.css">
{% if page.url == "/search" %}
<link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/instantsearch.js@2.6.0/dist/instantsearch.min.css">
<link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/instantsearch.js@2.6.0/dist/instantsearch-theme-algolia.min.css">
Expand Down
55 changes: 55 additions & 0 deletions docs/css/tabs.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@

.tab {
display: flex;
flex-wrap: wrap;
margin-left: -20px;
padding: 0;
list-style: none;
position: relative;
list-style-type: none;
}

ul.tab {
list-style-type: none;

}

.tab > * {
flex: none;
padding-left: 20px;
position: relative;
}

.tab > * > a {
display: block;
text-align: center;
padding: 9px 20px;
color: #999;
border-bottom: 2px solid transparent;
border-bottom-color: transparent;
font-size: 12px;
text-transform: uppercase;
transition: color .1s ease-in-out;
line-height: 20px;
}

.tab > .active > a {
color:#222;
border-color: #1e87f0;
}

.tab li a {
text-decoration: none;
cursor: pointer;
}

.tab-content{
padding: 0;
}

.tab-content li {
display: none;
}
.tab-content li.active {
display: initial;
}
60 changes: 26 additions & 34 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,63 +5,55 @@
<section>
<h1 class="title">Meltano Documentation</h1>
<!--<p class="subtitle">Subtitle</p>-->
<p>Welcome to the Meltano Documentation! Here you'll learn how to use Meltano, how Meltano is built, and where to get started.</p>
<p>To learn <strong>how to use Meltano</strong>, check out the <a href="/getting-started">Getting Started guide</a> and the additional guides and references linked from the Table of Contents in the sidebar.</p>
<p>To learn about <strong>contributing to Meltano</strong>, refer to the <a href="/contribute/">Contributor Guide</a>.</p>
<p>To learn more about the company, you can check our our <a href="https://handbook.meltano.com/">Company Handbook</a>. This site contains information about our <a href="https://handbook.meltano.com/company/values">values</a>, <a href="https://handbook.meltano.com/company/#mission">mission</a>, <a href="https://handbook.meltano.com/company/#vision">vision</a>, and <a href="https://handbook.meltano.com/product/roadmap">roadmap</a>, all of which guide how we build Meltano out in the open.</p>
</section>
<p>Welcome to the Meltano Documentation! Here you'll learn how to use Meltano, how Meltano is built, and where to get started.</p></section>

<section class="section">
<div class="columns">

<div class="column">
<h3 class="is-size-3 has-text-centered">Getting Started</h3>
<p class="has-text-centered">Learn the basics of Meltano and get up and running.</p>
<h2>First Steps</h2>
<p>Learn the basics of Meltano and get up and running.</p>
<p><b>Meltano from Scratch:</b></p>
<ul>
<li><a href="/getting-started">Getting Started Guide</a> - This guide will help you get started with installing and configuring Meltano.</li>
<li><a href="/guide/production">Deploying Meltano</a> - Already have a Meltano project? Learn how to deploy it here.</li>
<li><a href="/getting-started/installation">Install Meltano</a> - In-depth information on installing Meltano.</li>
<li><a href="https://handbook.meltano.com/marketing/community">Join the Community</a></li>
<li><a href="/contribute/">Contribute!</a></li>
<li><a href="/getting-started/meltano-at-a-glance">Meltano at a Glance</a></li>
<li><a href="/getting-started/installation">Install Meltano</a></li>
</ul>
</div>
<div class="column">
<h3 class="is-size-3 has-text-centered">Reference Documentation</h3>
<p class="has-text-centered">Dive into the core of Meltano and learn how to manage projects.</p>
<p><b>Tutorial:</b></p>
<ul>
<li><a href="/reference/command-line-interface">Command Line Reference</a></li>
<li><a href="/reference/ui">GUI Reference</a></li>
<li><a href="/reference/settings">Settings</a> </li>
<li><a href="/getting-started/part1">Part 1: Extract Data</a></li>
<li><a href="/getting-started/part2">Part 2: Loading Data, EL</a></li>
<li><a href="/getting-started/part3">Part 3: Transformations, ELT</a></li>
<li><a href="/getting-started/part4">Part 4: Inline Data Mapping, E(t)LT</a></li>
</ul>
</div>
</div>

<div class="columns">
<div class="column">
<h3 class="is-size-3 has-text-centered">Tutorials</h3>
<p class="has-text-centered">See real-world examples of Meltano.</p>
<h2>Tutorials & Examples</h2>
<p>See real-world examples of Meltano.</p>
<ul>
<li><a href="/tutorials/example-projects">Example & real Meltano projects</a></li>
<li><a href="/guide/containerization">Containerize Meltano</a></li>
<li><a href="/tutorials/custom-extractor">Create a Custom Extractor</a></li>
<li><a href="https://www.youtube.com/watch?v=DQDVBHxLU60">Create a Tap</a></li>
</ul>
</div>
<div class="column">
<h3 class="is-size-3 has-text-centered">Singer Documentation</h3>
<p class="has-text-centered">Learn more about Singer taps and targets.</p>

<h2>Reference Documentation</h2>
<p>Dive into the core of Meltano and learn how to manage projects.</p>
<ul>
<li><a href="/reference/command-line-interface">Command Line Reference</a></li>
<li><a href="/reference/ui">GUI Reference</a></li>
<li><a href="/reference/settings">Settings</a> </li>
</ul>

<h2>Singer Documentation</h2>
<p>Learn more about Singer taps and targets.</p>
<ul>
<li><a href="https://sdk.meltano.com">Singer SDK Documentation</a></li>
<li><a href="https://hub.meltano.com/singer/spec">Read the Singer Spec</a> </li>
<li><a href="https://hub.meltano.com/singer/">MeltanoHub for Singer</a></li>
<li><a href="https://github.com/MeltanoLabs/Singer-Working-Group">Singer Working Group</a></li>
</ul>
</div>
</div>

</section>

<section class="section">
<h2>Get Help</h2>
<h2 id="get-help">Get Help</h2>
<p>If you have a question about Meltano, are having trouble getting it to work, or have any kind of feedback, you can:

<div class="columns is-multiline is-centered">
Expand Down
43 changes: 43 additions & 0 deletions docs/js/tabs.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
const removeActiveClasses = function (ulElement) {
const lis = ulElement.querySelectorAll('li');
Array.prototype.forEach.call(lis, function(li) {
li.classList.remove('active');
});
}

const getChildPosition = function (element) {
var parent = element.parentNode;
var i = 0;
for (var i = 0; i < parent.children.length; i++) {
if (parent.children[i] === element) {
return i;
}
}

throw new Error('No parent found');
}

window.addEventListener('load', function () {
const tabLinks = document.querySelectorAll('ul.tab li a');

Array.prototype.forEach.call(tabLinks, function(link) {
link.addEventListener('click', function (event) {
event.preventDefault();

liTab = link.parentNode;
ulTab = liTab.parentNode;
position = getChildPosition(liTab);
if (liTab.className.includes('active')) {
return;
}

removeActiveClasses(ulTab);
tabContentId = ulTab.getAttribute('data-tab');
tabContentElement = document.getElementById(tabContentId);
removeActiveClasses(tabContentElement);

tabContentElement.querySelectorAll('li')[position].classList.add('active');
liTab.classList.add('active');
}, false);
});
});
8 changes: 4 additions & 4 deletions docs/src/_getting-started/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: Getting Started
title: Complete Tutorial
description: If you're ready to get started with Meltano and run an EL[T] pipeline with a data source and destination of your choosing, you've come to the right place!
layout: getting_started
weight: 2
weight: 5
---

Welcome! If you're ready to get started with Meltano and [run an EL[T] pipeline](#run-a-data-integration-el-pipeline)
Expand All @@ -16,7 +16,7 @@ with a [data source](#add-an-extractor-to-pull-data-from-a-source) and [destinat

Before you can get started with Meltano and the [`meltano` command line interface (CLI)](/reference/command-line-interface), you'll need to install it onto your system.

_To learn more about the different installation methods, refer to the [Installation guide](/getting-started/installation)._
_To learn more about the different installation methods, refer to the [Installation guide](/guide/installation-guide)._

### Local Installation

Expand Down Expand Up @@ -61,7 +61,7 @@ You will need to be running Linux, macOS, or Windows, and have [Python](https://
meltano --version
```

If anything's not performing as expected, refer to the ["Local Installation" section](/getting-started/installation#local-installation) of the [Installation guide](/getting-started/installation) for more details.
If anything's not performing as expected, refer to the ["Local Installation" section](/guide/installation-guide#local-installation) of the [Installation guide](/guide/installation-guide) for more details.

## Create Your Meltano Project

Expand Down

0 comments on commit f0a396a

Please sign in to comment.