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: restructure getting started #1749

Merged
merged 3 commits into from
Nov 1, 2024

Conversation

danthelion
Copy link
Contributor

@danthelion danthelion commented Oct 31, 2024

This PR restructures the beginning of the docs site to try and streamline the onboarding experience for new users. The main goal is to push down complex technical instructions (storage setup, flowctl, etc.) and emphasize dashboard-based onboarding actions with examples.


This change is Reviewable

@danthelion danthelion force-pushed the docs/restructure-getting-started branch from e4b9730 to 3fd275e Compare October 31, 2024 14:00
Copy link

github-actions bot commented Oct 31, 2024

PR Preview Action v1.4.8
Preview removed because the pull request was closed.
2024-11-01 16:09 UTC

Copy link
Contributor

@jonwihl jonwihl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

ask a question.

When you register for Flow, your account will use Flow's secure cloud storage bucket to store your data.
Data in Flow's cloud storage bucket is deleted 30 days after collection.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

20 days?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it? We refer to 30 days in the current docs

@@ -195,7 +195,7 @@ captures:

Your capture definition will likely be more complex, with additional bindings for each table in the source database.

[Learn more about capture definitions.](/concepts/captures.md#pull-captures)
[Learn more about capture definitions.](../../../../concepts/captures.md)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it not preferable to use root relative paths rather than document relative paths?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm yeah you're right, updated these changes. still need to remove the non-existant anchor

@danthelion danthelion merged commit 426055a into master Nov 1, 2024
4 checks passed
@danthelion danthelion deleted the docs/restructure-getting-started branch November 1, 2024 16:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants