Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Ready] Remove FAQ documentation content, fix links #2373

Merged
merged 17 commits into from
Mar 20, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Final tweaks following review
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
  • Loading branch information
stichbury committed Mar 20, 2023
commit 5cdb4da09ae15b3f50a7173ceb9ea9f225c49aaf
4 changes: 2 additions & 2 deletions docs/source/development/automated_testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Let's look at how you can start working with `pytest` in your Kedro project.

### Install `pytest`

Install `pytest` as you would install other packages with `pip`, making sure your [project's virtual environment is active](../get_started/install.md#create-a-python-virtual-environment-for-your-kedro-project).
Install `pytest` as you would install other packages with `pip`, making sure your [project's virtual environment is active](../get_started/install.md#create-a-virtual-environment-for-your-kedro-project).

```bash
pip install pytest
Expand Down Expand Up @@ -125,7 +125,7 @@ It can be useful to see how much of your project is covered by tests. For this,

### Install `pytest-cov`

Install `pytest` as you would install other packages with pip, making sure your [project's virtual environment is active](../get_started/install.md#create-a-python-virtual-environment-for-your-kedro-project).
Install `pytest` as you would install other packages with pip, making sure your [project's virtual environment is active](../get_started/install.md#create-a-virtual-environment-for-your-kedro-project).

```bash
pip install pytest-cov
Expand Down
2 changes: 1 addition & 1 deletion docs/source/development/commands_reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -396,7 +396,7 @@ _This command will be deprecated from Kedro version 0.19.0._
kedro build-docs
```

The `build-docs` command builds [project documentation](../tutorial/package_a_project.md#add-documentation-to-your-project) using the [Sphinx](https://www.sphinx-doc.org) framework. To further customise your documentation, please refer to `docs/source/conf.py` and the [Sphinx documentation](http://www.sphinx-doc.org/en/master/usage/configuration.html).
The `build-docs` command builds [project documentation](../tutorial/package_a_project.md#add-documentation-to-a-kedro-project) using the [Sphinx](https://www.sphinx-doc.org) framework. To further customise your documentation, please refer to `docs/source/conf.py` and the [Sphinx documentation](http://www.sphinx-doc.org/en/master/usage/configuration.html).


#### Lint your project
Expand Down
14 changes: 6 additions & 8 deletions docs/source/get_started/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ If you encounter any problems as you set up Kedro, ask for help on Kedro's [Slac

* **git**: You must install `git` onto your machine if you do not already have it. Type `git -v` into your terminal window to confirm it is installed; it will return the version of `git` available or an error message. [You can download `git` from the official website](https://git-scm.com/).

## Create a Python virtual environment for your Kedro project
## Create a virtual environment for your Kedro project

We strongly recommend [installing `conda` as your virtual environment manager](https://docs.conda.io/projects/conda/en/latest/user-guide/install/) if you don't already use it.

``` {tip}
[Read more about Python virtual environments](https://realpython.com/python-virtual-environments-a-primer/) or [watch an explainer video about them](https://youtu.be/YKfAwIItO7M).
[Read more about virtual environments for Python projects](https://realpython.com/python-virtual-environments-a-primer/) or [watch an explainer video about them](https://youtu.be/YKfAwIItO7M).
```

### How to create a new virtual environment using `conda`
Expand Down Expand Up @@ -58,7 +58,7 @@ To exit `kedro-environment`:
conda deactivate
```

### How to create a new Python virtual environment without using `conda`
### How to create a new virtual environment without using `conda`

Depending on your preferred Python installation, you can create virtual environments to work with Kedro using `venv` or `pipenv` instead of `conda`.

Expand Down Expand Up @@ -121,7 +121,7 @@ exit
</details>


## Install Kedro using `pip`
## How to install Kedro using `pip`

To install Kedro from the Python Package Index (PyPI):

Expand All @@ -131,7 +131,7 @@ pip install kedro

You can also install Kedro using `conda install -c conda-forge kedro`.

## Verify your Kedro installation
## How to verify your Kedro installation

To check that Kedro is installed:

Expand Down Expand Up @@ -162,12 +162,11 @@ To later upgrade Kedro to a different version, simply run:
pip install kedro -U
```

When migrating an existing project to a newer Kedro version, make sure you also update the `project_version`:
When migrating an existing project to a newer Kedro version, make sure you also update the `kedro_init_version`:

* For projects generated with versions of Kedro > 0.17.0, you'll do this in the `pyproject.toml` file from the project root directory.
* If your project was generated with a version of Kedro <0.17.0, you will instead need to update the `ProjectContext`, which is found in `src/<package_name>/run.py`.


## How to install a development version of Kedro

This section explains how to try out a development version of Kedro direct from the [Kedro GitHub repository](https://github.com/kedro-org/kedro).
Expand All @@ -190,4 +189,3 @@ If you want to roll back to a stable version of Kedro, execute the following in
pip uninstall kedro -y
pip install kedro
```

4 changes: 2 additions & 2 deletions docs/source/tutorial/package_a_project.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This section explains how to build project documentation, and how to bundle a Ke

Kedro also has an advanced feature which supports packaging on a pipeline level allowing you share and reuse pipelines across projects! To read more about this please look at the [section on micro-packaging](../nodes_and_pipelines/micro_packaging.md).

## Add documentation to your project
## Add documentation to a Kedro project

There are several documentation frameworks for Python projects. This section describes how to use [Sphinx](https://www.sphinx-doc.org).

Expand Down Expand Up @@ -97,7 +97,7 @@ make html
Consult the Sphinx project documentation for [additional options to pass to `sphinx-build`](https://www.sphinx-doc.org/en/master/man/sphinx-build.html). To customise your documentation beyond the basic template, you'll need to adjust the [Sphinx configuration settings](https://www.sphinx-doc.org/en/master/usage/configuration.html) which are stored in `docs/source/conf.py` file.
```

## Package your project
## Package a Kedro project

To package a project, run the following in your project root directory:

Expand Down
2 changes: 1 addition & 1 deletion docs/source/tutorial/tutorial_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ You may also want to store credentials such as usernames and passwords if they a

To do this, add them to `conf/local/credentials.yml` (some examples are included in that file for illustration).

### Configuration best practice to avoid leaking confidential data?
### Configuration best practice to avoid leaking confidential data

* Do not commit data to version control.
* Do not commit notebook output cells (data can easily sneak into notebooks when you don't delete output cells).
Expand Down