Skip to content

Commit

Permalink
Mention Git Dependancy in Documention (#4006)
Browse files Browse the repository at this point in the history
* Mention Git Dependancy in Documention

Signed-off-by: Yash Bhavsar <yashbhavsar3602@gmail.com>

* Fix lint

Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com>

* Apply suggestions from code review

Signed-off-by: Merel Theisen <49397448+merelcht@users.noreply.github.com>

---------

Signed-off-by: Yash Bhavsar <yashbhavsar3602@gmail.com>
Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com>
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 <merel.theisen@quantumblack.com>
Co-authored-by: ElenaKhaustova <157851531+ElenaKhaustova@users.noreply.github.com>
  • Loading branch information
4 people authored Aug 6, 2024
1 parent d47a8d2 commit 36c3fa9
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 3 deletions.
2 changes: 2 additions & 0 deletions docs/source/course/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion docs/source/deployment/single_machine.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
5 changes: 4 additions & 1 deletion docs/source/faq/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -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<kedro-viz:kedro-viz_visualisation>`?
Expand Down
2 changes: 1 addition & 1 deletion docs/source/get_started/new_project.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 2 additions & 0 deletions docs/source/starters/create_a_starter.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down

0 comments on commit 36c3fa9

Please sign in to comment.