From 734d6f33b7182fc026894e97e508f06ab4ed5ded Mon Sep 17 00:00:00 2001 From: Nikki Everett Date: Thu, 11 Apr 2024 18:16:28 -0500 Subject: [PATCH] Update "Creating a Flyte project" with link to new Dockerfile project template (#5215) * update with link to dockerfile template Signed-off-by: nikki everett * fix 404 error Signed-off-by: nikki everett --------- Signed-off-by: nikki everett --- .../creating_a_flyte_project.md | 6 +++--- .../flyte_project_components.md | 5 +++-- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/getting_started_with_workflow_development/creating_a_flyte_project.md b/docs/getting_started_with_workflow_development/creating_a_flyte_project.md index 7e9017664f..0e0160ec59 100644 --- a/docs/getting_started_with_workflow_development/creating_a_flyte_project.md +++ b/docs/getting_started_with_workflow_development/creating_a_flyte_project.md @@ -23,7 +23,7 @@ conda activate flyte-example Next, initialize your Flyte project. The [flytekit-python-template GitHub repository](https://github.com/flyteorg/flytekit-python-template) contains Flyte project templates with sample code that you can run as is or modify to suit your needs. -In this example, we will initialize the [basic-example-imagespec project template](https://github.com/flyteorg/flytekit-python-template/tree/main/basic-example-imagespec). +In this example, we will initialize the [basic-template-imagespec project template](https://github.com/flyteorg/flytekit-python-template/tree/main/basic-template-imagespec). ```{prompt} bash $ pyflyte init my_project @@ -31,9 +31,9 @@ pyflyte init my_project :::{note} -To initialize a Flyte project with a different template, use the `--template` parameter: +If you need to use a Dockerfile for your project, you can initialize the Dockerfile template: -`pyflyte init --template hello-world hello-world` +`pyflyte init --template basic-template-dockerfile my_project` ::: ### 3. Install additional requirements diff --git a/docs/getting_started_with_workflow_development/flyte_project_components.md b/docs/getting_started_with_workflow_development/flyte_project_components.md index 8c24946aad..47821c5201 100644 --- a/docs/getting_started_with_workflow_development/flyte_project_components.md +++ b/docs/getting_started_with_workflow_development/flyte_project_components.md @@ -1,3 +1,4 @@ +(flyte_project_components)= # Flyte project components A Flyte project is a directory containing task and workflow code, internal Python source code, configuration files, and other artifacts required to package up your code so that it can be run on a Flyte cluster. @@ -26,13 +27,13 @@ You can specify pip-installable Python dependencies in your project by adding th `requirements.txt` file. ```{note} -We recommend using [pip-compile](https://pip-tools.readthedocs.io/en/latest/) to +We recommend using [pip-compile](https://pip-tools.readthedocs.io/en/stable/) to manage your project's Python requirements. ``` ````{dropdown} See requirements.txt -```{rli} https://raw.githubusercontent.com/flyteorg/flytekit-python-template/main/simple-example/%7B%7Bcookiecutter.project_name%7D%7D/requirements.txt +```{rli} https://raw.githubusercontent.com/flyteorg/flytekit-python-template/main/basic-template-imagespec/%7B%7Bcookiecutter.project_name%7D%7D/requirements.txt :caption: requirements.txt ```