docs: refresh getting started guide (meltano#7678)

* refresh getting started guide * bump version number
BuzzCutNorman · May 19, 2023 · d179f1b · d179f1b
1 parent 0b0b7ef
commit d179f1b
Show file tree

Hide file tree

Showing 4 changed files with 155 additions and 98 deletions.
diff --git a/docs/src/_getting-started/part1.md b/docs/src/_getting-started/part1.md
@@ -21,7 +21,7 @@ We'll assume you have [Meltano installed](/getting-started/installation) already
 
 ```console
 $ meltano --version
-meltano, version 2.6.0
+meltano, version 2.19.0
 </div>
 <br />
 This tutorial is written using meltano >= v2.0.0.
@@ -101,7 +101,7 @@ Now that you have your very own Meltano project, it's time to add [plugins](/con
 1.  Add the GitHub extractor
 
 ```bash
-$ meltano add extractor tap-github --variant=meltanolabs
+meltano add extractor tap-github --variant=meltanolabs
 ```
 <br />
 
@@ -133,7 +133,6 @@ extractors:
     pip_url: git+https://github.com/MeltanoLabs/tap-github.git
 ```
 
-
 1.  Test that the installation was successful by calling [`meltano invoke`](/reference/command-line-interface#invoke):
 
 ```bash
@@ -174,29 +173,29 @@ The GitHub tap requires [configuration](/guide/configuration) before it can star
 1. The simplest way to configure a new plugin in Meltano is using the mode `interactive`:
 
 ```bash
-$ meltano config tap-github set --interactive
+meltano config tap-github set --interactive
 ```
 
-2. Follow the prompts to step through all available settings, the ones you'll need to fill out are repositories, start_date and your private_token.
+2. Follow the prompts to step through all available settings, the ones you'll need to fill out are repositories (formatted like `["sbalnojan/meltano-lightdash"]`), start_date, and your auth_token.
 <br>
 <div class="termy">
 
 ```console
 $ meltano config tap-github set --interactive
-Configuring Extractor 'tap-github'
+Configuring Extractor 'tap-github' Interactively
 [...]
 Settings
- 1. user_agent:                                                                                                                                                                                   [...]
- 3. auth_token: GitHub token to authenticate ...
-[...]
+ 1. additional_auth_tokens:                                                       [...]
+ 2. auth_token: GitHub token to authenticate ...
+ [...]
  8. repositories: An array of strings containing the github repos to be ...
-[...]
+ [...]
  11. start_date:
  [...]
-To learn more about extractor 'tap-github' and its settings, visit https://hub.meltano.com/extractors/tap-github
+To learn more about extractor 'tap-github' and its settings, visit https://hub.meltano.com/extractors/tap-github--meltanolabs
 
-Loop through all settings (all), select a setting by number (1 - 11), or exit (e)? [all]:
-$ 3
+Loop through all settings (all), select a setting by number (1 - 16), or exit (e)? [all]:
+$ 2
 [...]Description:
 GitHub token to authenticate with.
 New value:
@@ -216,17 +215,14 @@ This will add the configuration to your [`meltano.yml` project file](/concepts/p
           config:
             start_date: '2022-01-01'
             repositories:
-              - sbalnojan/meltano-lightdash
+            - sbalnojan/meltano-lightdash
   ```
 
 It will also add your secret auth token to the file `.env`:
   ```yml
   TAP_GITHUB_AUTH_TOKEN='ghp_XXX' # your token!
   ```
 
-
-
-
 3. Double check the config by running [`meltano config tap-github`](/reference/command-line-interface#config):
 
 ```bash
@@ -267,7 +263,8 @@ meltano select tap-github --list --all
 
 ```console
 $ meltano select tap-github --list
-2022-09-19T10:59:43.554214Z [info     ] Environment 'dev' is active
+2023-05-17T20:07:24.085827Z [info     ] The default environment 'dev' will be ignored for 'meltano select'. To configure a specific environment, please use the option '--environment=environment name'.
+
 Legend:
         selected
         excluded
@@ -305,14 +302,6 @@ This will add the [selection rules](/concepts/plugins#select-extra) to your [`me
   default_environment: dev
   environments:
   - name: dev
-    config:
-      plugins:
-        extractors:
-        - name: tap-github
-          select:
-          - commits.url
-          - commits.sha
-          - commits.commit_timestamp
   - name: staging
   - name: prod
   project_id: YOUR_ID
@@ -325,6 +314,11 @@ This will add the [selection rules](/concepts/plugins#select-extra) to your [`me
         start_date: '2022-01-01'
         repositories:
         - sbalnojan/meltano-lightdash
+      select:
+      - commits.url
+      - commits.sha
+      - commits.commit_timestamp
+
   ```
 
 
@@ -337,12 +331,12 @@ meltano select tap-github --list
 ## Add a dummy loader to dump the data into JSON
 To test that the extraction process works, we add a JSON target.
 
-1. Add the JSON target using ```meltano add loader target-jsonl```.
+1. Add the JSON target using ```meltano add loader target-jsonl --variant=andyh1203```.
 <br>
 <div class="termy">
 
 ```console
-$ meltano add loader target-jsonl</span>
+$ meltano add loader target-jsonl --variant=andyh1203</span>
 Added loader 'target-jsonl' to your Meltano project
 Variant:        andyh1203 (default)
 Repository:     https://github.com/andyh1203/target-jsonl
@@ -364,7 +358,7 @@ Now that [your Meltano project](#create-your-meltano-project), [extractor](#add-
 There's just one step here: run your newly added extractor and jsonl loader in a pipeline using [`meltano run`](/reference/command-line-interface#run):
 
 ```bash
-$ meltano run tap-github target-jsonl
+meltano run tap-github target-jsonl
 ```
 <br>
 <div class="termy">
@@ -390,7 +384,7 @@ You can verify that it worked by looking inside the newly created file called ``
 
 ```console
 $ cat output/commits.jsonl
-{"sha": "409bdd601e0531833665f538bccecd0f69e101c0", "url": "https://api.github.com/repos/sbalnojan/meltano-lightdash/commits/409bdd601e0531833665f538bccecd0f69e101c0"}
+{"sha": "409bdd601e0531833665f538bccecd0f69e101c0", "node_id": "C_kwDOH_twHNoAKDQwOWJkZDYwMWUwNTMxODMzNjY1ZjUzOGJjY2VjZDBmNjllMTAxYzA", "url": "https://api.github.com/repos/sbalnojan/meltano-lightdash/commits/409bdd601e0531833665f538bccecd0f69e101c0", "commit_timestamp": "2022-09-14T12:41:21Z"}
 ```
 
 </div>

diff --git a/docs/src/_getting-started/part2.md b/docs/src/_getting-started/part2.md
@@ -20,7 +20,7 @@ In  [part 1](/getting-started/part1), we extracted data from GitHub and are now
 We're going to load our data into a dockerized PostgreSQL database running on your laptop. View the [docker docs](https://docs.docker.com/get-docker/) if you don't yet have docker installed. To launch a local PostgreSQL container, you just need to run:
 
 ```bash
-$ docker run -p 5432:5432 -e POSTGRES_USER=meltano -e POSTGRES_PASSWORD=password -d postgres
+docker run --name meltano_postgres -p 5432:5432 -e POSTGRES_USER=meltano -e POSTGRES_PASSWORD=password -d postgres
 ```
 <br />
 <div class="termy">
@@ -155,11 +155,13 @@ You can use `meltano config target-postgres` to check the configuration, includi
 ```console
 $ meltano config target-postgres
 {
+&ensp;&ensp;&ensp;&ensp;"add_record_metadata": true,
+&ensp;&ensp;&ensp;&ensp;"database": "postgres",
+&ensp;&ensp;&ensp;&ensp;"dialect+driver": "postgresql+psycopg2",
 &ensp;&ensp;&ensp;&ensp;"host": "localhost",
-&ensp;&ensp;&ensp;&ensp;"user": "meltano",
 &ensp;&ensp;&ensp;&ensp;"password": "password",
-&ensp;&ensp;&ensp;&ensp;"database": "postgres",
-&ensp;&ensp;&ensp;&ensp;"add_record_metadata": true
+&ensp;&ensp;&ensp;&ensp;"port": 5432,
+&ensp;&ensp;&ensp;&ensp;"user": "meltano"
 }
 ```
 </div>
@@ -190,6 +192,7 @@ $ meltano run tap-github target-postgres
 </div>
 <br />
 If everything was configured correctly, you should now see your data flow from your source into your destination!
+The postgres database should now have a schema `tap_github` with the table `commits` containing your data.
 
 ## Next Steps