From 9febb901618d04434343596fd31ae2af5dd01ce5 Mon Sep 17 00:00:00 2001 From: goFrendiAsgard Date: Fri, 15 Dec 2023 06:49:45 +0700 Subject: [PATCH] adjust link --- docs/getting-started.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/docs/getting-started.md b/docs/getting-started.md index a05e6014..ff4cc16f 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -22,8 +22,12 @@ Welcome to Zrb's getting started guide. We will cover everything you need to kno - [Using `project.sh`](#using-projectsh) - [Creating a Task](#creating-a-task) - [Task Definition](#task-definition) + - [Common Task Properties](#common-task-properties) + - [Task Dependencies](#task-dependencies) + - [Task Inputs](#task-inputs) + - [Task Environments](#task-environments) - [Basic Example](#basic-example) -- [More Example](#more-example) + - [Advance Example](#advance-example-long-running-task) This guide assumes you have some familiarity with CLI and Python. @@ -789,7 +793,7 @@ Finally, by invoking `runner.register(hello, hello_cmd, hello_py)`; we want the 👉 Click here to break down the code 👈 -## Import Statement +### Import Statement
@@ -814,7 +818,7 @@ At the very beginning, we import some resources from `zrb` package: - `Env`: We need this class to define Task Environments. - `StrInput`: We need this class to define Task Input/Parameter. -## `hello-cmd` Definition +### `hello-cmd` Definition
@@ -844,7 +848,7 @@ To access the value of `MODE` environment, we can use `{{ env.MODE }}`. Meanwhile, to access the value of `user-name` parameter, we can use `{{ input.user_name }}`. Notice how Zrb translates the input name into `snake_case`. -## `hello-py` Definition +### `hello-py` Definition
@@ -893,7 +897,7 @@ env_map = task.get_env_map() mode = env_map.get('MODE') ``` -## `hello` Definition And Its Dependencies +### `hello` Definition And Its Dependencies
@@ -920,7 +924,7 @@ hello-py ───┐ hello-cmd ──┘ ``` -## Register Tasks to The `runner` +### Register Tasks to The `runner`
@@ -947,7 +951,7 @@ zrb hello -## The Output +### The Output
@@ -987,7 +991,7 @@ zrb hello Now you will see `Current mode: PROD` instead of `Current mode: DEV`. -## Advance Example: Long Running Task +### Advance Example: Long Running Task Let's start with a use case: