Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: make it more clear where the official docs are #137

Merged
merged 26 commits into from
Oct 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,25 @@
<h1 align="left">abctl</h1>
Airbyte's command line tool for local Airbyte deployments.
<br clear="left"/>
<br />

> [!NOTE]
> This README primarily focuses on the `abctl` tool itself, not the Airbyte platform.
>
> If you're looking for Airbyte's official quickstart documentation, that can be found [here](https://docs.airbyte.com/using-airbyte/getting-started/oss-quickstart).

---

- [Quickstart](#quickstart)
- [Commands](#commands)
- [Contributing](#contributing)

# Quickstart

> [!TIP]
> Additional documentation can be found in the [Airbyte Documentation](https://docs.airbyte.com/using-airbyte/getting-started/oss-quickstart).
# Abctl Quickstart

> [!IMPORTANT]
> Credentials are randomly generated as part of the installation process.
> Authentication credentials are randomly generated as part of the installation process.
>
> After installation is complete, to find your credentials run `abctl local credentials`.
> After installation is complete, to find your authentication credentials run `abctl local credentials`.

1. Install `Docker`
- [Linux](https://docs.docker.com/desktop/install/linux-install/)
Expand Down Expand Up @@ -241,7 +244,7 @@ Displays version information about the `abctl` tool.
For example:
```
$ abctl version
version: v0.12.0
version: v0.19.0
```

# Contributing
Expand Down
2 changes: 1 addition & 1 deletion internal/telemetry/segment.go
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ func WithHTTPClient(d Doer) Option {
}
}

// WithSessionID overrides the default ulid session, primarily for testing purposes.
// WithSessionID overrides the default uuid session, primarily for testing purposes.
func WithSessionID(sessionID uuid.UUID) Option {
return func(client *SegmentClient) {
client.sessionID = sessionID
Expand Down