diff --git a/docs/assets/img/quickstart/quickstart-repo.gif b/docs/assets/img/quickstart/quickstart-repo.gif deleted file mode 100644 index 398fe59aa33..00000000000 Binary files a/docs/assets/img/quickstart/quickstart-repo.gif and /dev/null differ diff --git a/docs/assets/img/quickstart/quickstart-repo.png b/docs/assets/img/quickstart/quickstart-repo.png new file mode 100644 index 00000000000..e25c5e1802c Binary files /dev/null and b/docs/assets/img/quickstart/quickstart-repo.png differ diff --git a/docs/quickstart/actions-and-hooks.md b/docs/quickstart/actions-and-hooks.md index 12b8232bef5..83ef926577e 100644 --- a/docs/quickstart/actions-and-hooks.md +++ b/docs/quickstart/actions-and-hooks.md @@ -32,51 +32,51 @@ _Hooks_ can be either a [Lua]({% link howto/hooks/lua.md %}) script that lakeFS --source lakefs://quickstart/main ``` -1. Open up your favorite text editor (or emacs), and paste the following YAML: - - ```yaml - name: Check Commit Message and Metadata - on: - pre-commit: - branches: - - etl** - hooks: - - id: check_metadata - type: lua - properties: - script: | - commit_message=action.commit.message - if commit_message and #commit_message>0 then - print("✅ The commit message exists and is not empty: " .. commit_message) - else - error("\n\n❌ A commit message must be provided") - end - - job_name=action.commit.metadata["job_name"] - if job_name == nil then - error("\n❌ Commit metadata must include job_name") - else - print("✅ Commit metadata includes job_name: " .. job_name) - end - - version=action.commit.metadata["version"] - if version == nil then - error("\n❌ Commit metadata must include version") - else - print("✅ Commit metadata includes version: " .. version) - if tonumber(version) then - print("✅ Commit metadata version is numeric") - else - error("\n❌ Version metadata must be numeric: " .. version) - end - end - ``` - -1. Save this file as `/tmp/check_commit_metadata.yml` +2. Open up your favorite text editor (or emacs), and paste the following YAML: + + ```yaml + name: Check Commit Message and Metadata + on: + pre-commit: + branches: + - etl** + hooks: + - id: check_metadata + type: lua + properties: + script: | + commit_message=action.commit.message + if commit_message and #commit_message>0 then + print("✅ The commit message exists and is not empty: " .. commit_message) + else + error("\n\n❌ A commit message must be provided") + end + + job_name=action.commit.metadata["job_name"] + if job_name == nil then + error("\n❌ Commit metadata must include job_name") + else + print("✅ Commit metadata includes job_name: " .. job_name) + end + + version=action.commit.metadata["version"] + if version == nil then + error("\n❌ Commit metadata must include version") + else + print("✅ Commit metadata includes version: " .. version) + if tonumber(version) then + print("✅ Commit metadata version is numeric") + else + error("\n❌ Version metadata must be numeric: " .. version) + end + end + ``` + +3. Save this file as `/tmp/check_commit_metadata.yml` * You can save it elsewhere, but make sure you change the path below when uploading -1. Upload the `check_commit_metadata.yml` file to the `add_action` branch under `_lakefs_actions/`. As above, you can use the UI (make sure you select the correct branch when you do), or with `lakectl`: +4. Upload the `check_commit_metadata.yml` file to the `add_action` branch under `_lakefs_actions/`. As above, you can use the UI (make sure you select the correct branch when you do), or with `lakectl`: ```bash docker exec lakefs \ @@ -85,13 +85,13 @@ _Hooks_ can be either a [Lua]({% link howto/hooks/lua.md %}) script that lakeFS --source /tmp/check_commit_metadata.yml ``` -1. Go to the **Uncommitted Changes** tab in the UI, and make sure that you see the new file in the path shown: +5. Go to the **Uncommitted Changes** tab in the UI, and make sure that you see the new file in the path shown: lakeFS Uncommitted Changes view showing a file called `check_commit_metadata.yml` under the path `_lakefs_actions/` Click **Commit Changes** and enter a suitable message to commit this new file to the branch. -1. Now we'll merge this new branch into `main`. From the **Compare** tab in the UI compare the `main` branch with `add_action` and click **Merge** +6. Now we'll merge this new branch into `main`. From the **Compare** tab in the UI compare the `main` branch with `add_action` and click **Merge** lakeFS Compare view showing the difference between `main` and `add_action` branches diff --git a/docs/quickstart/branch.md b/docs/quickstart/branch.md index b3434a227d4..c6ceae4ec03 100644 --- a/docs/quickstart/branch.md +++ b/docs/quickstart/branch.md @@ -131,4 +131,4 @@ DESC LIMIT 5; ``` The lakeFS object browser showing DuckDB querying lakes.parquet on the main branch. The results are the same as they were before we made the changes to the denmark-lakes branch, which is as expected. -In the next step we'll see how to merge our branch back into main. +In the next step we'll see how to commit our changes and merge our branch back into main.