Skip to content

Commit

Permalink
docs: Use tabs for examples on settings page (#8201)
Browse files Browse the repository at this point in the history
* Split settings examples by type

Settings are split by the following where appropriate:

- meltano init
- meltano config
- export (environment variable)
- meltano command

* Remove settings file, renamed settings.mdx

* Move and rename tabs for consistency

* Update to enable "meltano config" to appear on one line in tab header

* Add fancy menu-color-active blue to selected tab

* Optional: Add queryString to shift all tabs as one

E.g. if you click on 'env' all tabs on the page shift to 'env' - helpful
if you have chosen one config style and want to stick to it for all
settings/config

---------

Co-authored-by: Edgar Ramírez Mondragón <edgar@meltano.com>
  • Loading branch information
mjsqu and edgarrmondragon committed Oct 3, 2023
1 parent 39f2e56 commit 4dcafc2
Show file tree
Hide file tree
Showing 3 changed files with 280 additions and 17 deletions.
22 changes: 11 additions & 11 deletions docs/docs/concepts/plugins.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ If the catalog does not seem to take effect, you may need to [validate the capab

Manage this extra:

<Tabs className="meltano-tabs">
<Tabs className="meltano-tabs" queryString="meltano-tabs">
<TabItem className="meltano-tab-content" value="meltano.yml" label="meltano.yml" default>

```yaml
Expand Down Expand Up @@ -234,7 +234,7 @@ It is used as the default value for the [`target-postgres`](https://hub.meltano.

Manage this extra:

<Tabs className="meltano-tabs">
<Tabs className="meltano-tabs" queryString="meltano-tabs">
<TabItem className="meltano-tab-content" value="meltano.yml" label="meltano.yml" default>

```yaml
Expand Down Expand Up @@ -293,7 +293,7 @@ Entity and attribute names can be discovered using [`meltano select --list --all

Manage this extra:

<Tabs className="meltano-tabs">
<Tabs className="meltano-tabs" queryString="meltano-tabs">
<TabItem className="meltano-tab-content" value="meltano.yml" label="meltano.yml" default>

```yaml
Expand Down Expand Up @@ -365,7 +365,7 @@ This allows you to define a full schema for taps such as [`tap-dynamodb`](https:

Manage this extra:

<Tabs className="meltano-tabs">
<Tabs className="meltano-tabs" queryString="meltano-tabs">
<TabItem className="meltano-tab-content" value="meltano.yml" label="meltano.yml" default>

```yaml
Expand Down Expand Up @@ -429,7 +429,7 @@ selection rules are typically specified using [`meltano select`](/reference/comm

Manage this extra:

<Tabs className="meltano-tabs">
<Tabs className="meltano-tabs" queryString="meltano-tabs">
<TabItem className="meltano-tab-content" value="meltano.yml" label="meltano.yml" default>

```yaml
Expand Down Expand Up @@ -494,7 +494,7 @@ selection filers are typically specified using [`meltano elt`](/reference/comman
Manage this extra:
<Tabs className="meltano-tabs">
<Tabs className="meltano-tabs" queryString="meltano-tabs">
<TabItem className="meltano-tab-content" value="meltano.yml" label="meltano.yml" default>
```yaml
Expand Down Expand Up @@ -559,7 +559,7 @@ a state file is typically provided using [`meltano elt`](/reference/command-line
Manage this extra:
<Tabs className="meltano-tabs">
<Tabs className="meltano-tabs" queryString="meltano-tabs">
<TabItem className="meltano-tab-content" value="meltano.yml" label="meltano.yml" default>
```yaml
Expand Down Expand Up @@ -628,7 +628,7 @@ It is used as the default value for `dbt`'s `target` setting, and should therefo
Manage this extra:
<Tabs className="meltano-tabs">
<Tabs className="meltano-tabs" queryString="meltano-tabs">
<TabItem className="meltano-tab-content" value="meltano.yml" label="meltano.yml" default>
```yaml
Expand Down Expand Up @@ -703,7 +703,7 @@ It is included in the default value for `dbt`'s `models` setting: `$MELTANO_TRAN
Manage this extra:
<Tabs className="meltano-tabs">
<Tabs className="meltano-tabs" queryString="meltano-tabs">
<TabItem className="meltano-tab-content" value="meltano.yml" label="meltano.yml" default>
```yaml
Expand Down Expand Up @@ -753,7 +753,7 @@ Because these variables are handled by dbt rather than Meltano, [environment var
Manage this extra:
<Tabs className="meltano-tabs">
<Tabs className="meltano-tabs" queryString="meltano-tabs">
<TabItem className="meltano-tab-content" value="meltano.yml" label="meltano.yml" default>
```yaml
Expand Down Expand Up @@ -845,7 +845,7 @@ When a file path's value is `True`, the matching files are considered to be mana
Manage this extra:
<Tabs className="meltano-tabs">
<Tabs className="meltano-tabs" queryString="meltano-tabs">
<TabItem className="meltano-tab-content" value="meltano.yml" label="meltano.yml" default>
```yaml
Expand Down
Loading

0 comments on commit 4dcafc2

Please sign in to comment.