From 36c3fa9c09c7417c6fe078f0cb211fedb8552d1b Mon Sep 17 00:00:00 2001 From: Yash Bhavsar <90474296+yashexe@users.noreply.github.com> Date: Tue, 6 Aug 2024 11:44:32 -0400 Subject: [PATCH] Mention Git Dependancy in Documention (#4006) * Mention Git Dependancy in Documention Signed-off-by: Yash Bhavsar * Fix lint Signed-off-by: Merel Theisen * Apply suggestions from code review Signed-off-by: Merel Theisen <49397448+merelcht@users.noreply.github.com> --------- Signed-off-by: Yash Bhavsar Signed-off-by: Merel Theisen Signed-off-by: Merel Theisen <49397448+merelcht@users.noreply.github.com> Co-authored-by: Merel Theisen <49397448+merelcht@users.noreply.github.com> Co-authored-by: Merel Theisen Co-authored-by: ElenaKhaustova <157851531+ElenaKhaustova@users.noreply.github.com> --- docs/source/course/index.md | 2 ++ docs/source/deployment/single_machine.md | 2 +- docs/source/faq/faq.md | 5 ++++- docs/source/get_started/new_project.md | 2 +- docs/source/starters/create_a_starter.md | 2 ++ 5 files changed, 10 insertions(+), 3 deletions(-) diff --git a/docs/source/course/index.md b/docs/source/course/index.md index 6cb3b27f2c..8b3f49c14f 100644 --- a/docs/source/course/index.md +++ b/docs/source/course/index.md @@ -22,6 +22,8 @@ We assume you know these concepts: We don't assume knowledge of software engineering in Python, so the course contains information about reusability principles, how to create a Python package, and how to use version control. +Please note that we do expect users to have Git installed, as it is a prerequisite for the `kedro new` flow, which is used when creating a new project. + ## What you'll learn In short, you'll learn answers to the following: diff --git a/docs/source/deployment/single_machine.md b/docs/source/deployment/single_machine.md index b70ddfcf60..7a5c64c1d6 100644 --- a/docs/source/deployment/single_machine.md +++ b/docs/source/deployment/single_machine.md @@ -71,7 +71,7 @@ If neither containers nor packages are viable options for your project, you can You will need to follow these steps to get your project running: ### Use GitHub workflow to copy your project -This workflow posits that development of the Kedro project is done on a local environment under version control by Git. Commits are pushed to a remote server (e.g. GitHub, GitLab, Bitbucket, etc.). +This workflow assumes that development of the Kedro project is done on a local environment under version control by Git. Commits are pushed to a remote server (e.g. GitHub, GitLab, Bitbucket, etc.). Deployment of the (latest) code on a production server is accomplished through cloning and the periodic pulling of changes from the Git remote. The pipeline is then executed on the server. diff --git a/docs/source/faq/faq.md b/docs/source/faq/faq.md index 6f152b41fe..b821192ad5 100644 --- a/docs/source/faq/faq.md +++ b/docs/source/faq/faq.md @@ -6,7 +6,10 @@ This is a growing set of technical FAQs. The [product FAQs on the Kedro website] ## Installing Kedro * [How do I install a development version of Kedro](https://github.com/kedro-org/kedro/wiki/Guidelines-for-contributing-developers)? -* **How can I check the version of Kedro installed?** To check the version installed, type `kedro -V` in your terminal window. +* **How can I check the version of Kedro installed?** + To check the version installed, type `kedro -V` in your terminal window. +* **Do I need Git installed to use Kedro?** + Yes, users are expected to have Git installed when working with Kedro. This is a prerequisite for the `kedro new` flow. If Git is not installed, use the following workaround: `kedro new -s https://github.com/kedro-org/kedro-starters/archive/0.18.6.zip --directory=pandas-iris` ## Kedro documentation * {doc}`Where can I find the documentation about Kedro-Viz`? diff --git a/docs/source/get_started/new_project.md b/docs/source/get_started/new_project.md index 85f15cbdcd..10410cee1b 100644 --- a/docs/source/get_started/new_project.md +++ b/docs/source/get_started/new_project.md @@ -1,6 +1,6 @@ # Create a new Kedro project -There are several ways to create a new Kedro project. This page explains the flow to create a basic project using `kedro new` to output a project directory containing the basic files and subdirectories that make up a Kedro project. +There are several ways to create a new Kedro project. This page explains the flow to create a basic project using `kedro new` to output a project directory containing the basic files and subdirectories that make up a Kedro project. Please note that users are expected to have [`Git`](https://git-scm.com/) installed, as it is a requirement for the `kedro new` flow. You can also create a new Kedro project with a starter that adds code for a common project use case. [Starters are explained separately](../starters/starters.md) and the [spaceflights tutorial](../tutorial/tutorial_template.md) illustrates their use. diff --git a/docs/source/starters/create_a_starter.md b/docs/source/starters/create_a_starter.md index f988f0245d..7abb080335 100644 --- a/docs/source/starters/create_a_starter.md +++ b/docs/source/starters/create_a_starter.md @@ -4,6 +4,8 @@ Kedro starters are a useful way to create a new project that contains code to ru A team may find it useful to build Kedro starters to create reusable projects that bootstrap a common base and can be extended. +Please note that users are expected to have [`Git`](https://git-scm.com/) installed for the `kedro new` flow, which is used in this section. + ## Install the `cookiecutter` package A Kedro starter is a [Cookiecutter](https://cookiecutter.readthedocs.io/) template that contains the boilerplate code for a Kedro project. First install `cookiecutter` as follows: