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

New Quickstart #5565

Merged
merged 29 commits into from Apr 3, 2023
Merged

New Quickstart #5565

merged 29 commits into from Apr 3, 2023

Conversation

rmoff
Copy link
Contributor

@rmoff rmoff commented Mar 23, 2023

Preview

https://treeverse-lakefs-preview-pr-5565.surge.sh/quickstart/

Change Description

Background

The existing quickstart does not provide enough of a quick start, both in terms of deployment and the experience of using lakeFS. This new quickstart aims to fix that by:

  • removing the options around deployment (it's Docker Compose only)
  • guiding the user through a simple example of branching data, merging, and rolling back.

It also adds a "learn more" page to guide the user on their journey.

For background notes and analysis on quickstarts on other projects please see https://github.com/treeverse/devex-internal/issues/173

Post-launch tasks / notes

Linked Issue

Closes https://github.com/treeverse/devex-internal/issues/173

@rmoff rmoff added docs Improvements or additions to documentation exclude-changelog PR description should not be included in next release changelog minor-change Used for PRs that don't require issue attached labels Mar 23, 2023
@github-actions
Copy link

No linked issues found. Please add the corresponding issues in the pull request description.
Use GitHub automation to close the issue when a PR is merged

@rmoff rmoff changed the title New Quickstart New Quickstart **DO NOT MERGE YET** Mar 23, 2023
@rmoff rmoff marked this pull request as ready for review March 23, 2023 16:10
@rmoff
Copy link
Contributor Author

rmoff commented Mar 29, 2023

@eladlachmi as discussed, please could you advise on how to remove the default box shadow that Just the Docs theme forces on to any <table> element? And also offer general improvements/fixes to the hatchet job that I've done on the CSS in that table? It's intended to mirror the look of this table.

@rmoff rmoff marked this pull request as draft March 29, 2023 18:06
Copy link
Contributor

@adipolak adipolak left a comment

Choose a reason for hiding this comment

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

Great work! I enjoyed waking through the quickstart, storytelling and scenario.
There are minor changes/tweaks in comments and I believe it would be good to go. thank you!

docs/quickstart/index.md Outdated Show resolved Hide resolved
docs/quickstart/index.md Outdated Show resolved Hide resolved
docs/quickstart/index.md Show resolved Hide resolved
docs/quickstart/launch.md Outdated Show resolved Hide resolved
quickstart/docker-compose.yml Show resolved Hide resolved
docs/quickstart/branch.md Show resolved Hide resolved
docs/quickstart/branch.md Show resolved Hide resolved
docs/quickstart/commit-and-merge.md Show resolved Hide resolved
docs/quickstart/rollback.md Show resolved Hide resolved
docs/quickstart/learning-more-lakefs.md Outdated Show resolved Hide resolved
@github-actions
Copy link

github-actions bot commented Mar 30, 2023

🎊 PR Preview e56d800 has been successfully built and deployed to https://treeverse-lakeFS-preview-pr-5565.surge.sh

🕐 Build time: 0.012s

🤖 By surge-preview

@rmoff rmoff changed the title New Quickstart **DO NOT MERGE YET** New Quickstart Mar 30, 2023
@rmoff rmoff marked this pull request as ready for review March 30, 2023 16:01
@rmoff rmoff requested a review from adipolak March 30, 2023 16:01
@rmoff rmoff requested a review from eladlachmi March 31, 2023 10:15
Copy link
Contributor

@adipolak adipolak left a comment

Choose a reason for hiding this comment

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

LGTM! if anything breaks, there is always revert :-)

@rmoff rmoff enabled auto-merge (squash) April 3, 2023 13:35
@rmoff rmoff disabled auto-merge April 3, 2023 13:52
@rmoff rmoff merged commit 69de5d2 into master Apr 3, 2023
36 of 37 checks passed
@rmoff rmoff deleted the docs/devex-173-quickstart branch April 3, 2023 13:53
nopcoder pushed a commit that referenced this pull request Apr 17, 2023
* Experimenting with a new quickstart

* source file

* Add branch protection on main

* WIP: new quickstart VERY ROUGH DRAFT

* Make 'Next' nav button green instead of outline'

* - updated screenshots for 0.97.2
- fixed nav
- still some tidying to do

* Fix image paths, add 'learning more' draft

* Update links, more learning notes

* Change CTA button

* Tweak learn doc

* Add placeholder link for doc for connecting to object store

* Add Dockerfile for duckDB build

* Comment out pull_policy for now since it's not supported on earlier version of Docker and I'm not convinced we need it for the compatibility problems it might introduce

* Add description metadata

* Add redirect for pages from old quickstart

* Add note about shutting down Docker Compose environment

* Re-integrate instructions on how to run lakeFS locally with non-local object store

* Add CSS rules for quickstart (very hacky! please improve)

* Add placeholder images

* Fix table dropshadow by using divs instead, thanks @eladlachmi

* Add fancy icons

* Address review comments from @adipolak

* Fix broken links

* Capitalisation for DuckDB

* Add border to quickstart images, and alt text for all of them

* Fix broken link

* Change terminology to `multi-table transaction`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation exclude-changelog PR description should not be included in next release changelog minor-change Used for PRs that don't require issue attached
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants