Clean up kedro pipeline create outdated docs (#2945)

* remove the README template generate by kedro pipeline create Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * fix docstring for kedro catalog create Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * Fix broken link Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * fix broken link Signed-off-by: Nok <nok.lam.chan@quantumblack.com> --------- Signed-off-by: Nok <nok.lam.chan@quantumblack.com> Co-authored-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
kedro-org · Aug 21, 2023 · 74b2a88 · 74b2a88
1 parent fa0e830
commit 74b2a88
Show file tree

Hide file tree

Showing 5 changed files with 2 additions and 26 deletions.
diff --git a/kedro/framework/cli/catalog.py b/kedro/framework/cli/catalog.py
@@ -137,7 +137,7 @@ def create_catalog(metadata: ProjectMetadata, pipeline_name, env):
     the ``DataCatalog``.
 
     The catalog configuration will be saved to
-    `<conf_source>/<env>/catalog/<pipeline_name>.yml` file.
+    `<conf_source>/<env>/catalog_<pipeline_name>.yml` file.
     """
     env = env or "base"
     session = _create_session(metadata.package_name, env=env)

diff --git a/kedro/templates/pipeline/{{ cookiecutter.pipeline_name }}/README.md b/kedro/templates/pipeline/{{ cookiecutter.pipeline_name }}/README.md
diff --git a/...e/{{ cookiecutter.pipeline_name }}/config/parameters_{{ cookiecutter.pipeline_name }}.yml b/...e/{{ cookiecutter.pipeline_name }}/config/parameters_{{ cookiecutter.pipeline_name }}.yml
@@ -2,4 +2,4 @@
 # using Kedro {{ cookiecutter.kedro_version }}.
 #
 # Documentation for this file format can be found in "Parameters"
-# Link: https://docs.kedro.org/en/{{ cookiecutter.kedro_version }}/kedro_project_setup/configuration.html#parameters
+# Link: https://docs.kedro.org/en/{{ cookiecutter.kedro_version }}/configuration/parameters.html
diff --git a/tests/framework/cli/micropkg/test_micropkg_package.py b/tests/framework/cli/micropkg/test_micropkg_package.py
@@ -30,7 +30,6 @@ def assert_sdist_contents_correct(
 
         expected_files = {
             f"{package_name}-{version}/{package_name}/__init__.py",
-            f"{package_name}-{version}/{package_name}/README.md",
             f"{package_name}-{version}/{package_name}/nodes.py",
             f"{package_name}-{version}/{package_name}/pipeline.py",
             f"{package_name}-{version}/{package_name}/config/parameters_{package_name}.yml",
@@ -264,7 +263,6 @@ def test_package_micropkg_no_config(
 
         expected_files = {
             f"{PIPELINE_NAME}-{version}/{PIPELINE_NAME}/__init__.py",
-            f"{PIPELINE_NAME}-{version}/{PIPELINE_NAME}/README.md",
             f"{PIPELINE_NAME}-{version}/{PIPELINE_NAME}/nodes.py",
             f"{PIPELINE_NAME}-{version}/{PIPELINE_NAME}/pipeline.py",
             f"{PIPELINE_NAME}-{version}/tests/__init__.py",

diff --git a/tests/framework/cli/micropkg/test_micropkg_pull.py b/tests/framework/cli/micropkg/test_micropkg_pull.py
@@ -51,7 +51,6 @@ def assert_package_files_exist(self, source_path):
             "__init__.py",
             "nodes.py",
             "pipeline.py",
-            "README.md",
         }
 
     @pytest.mark.parametrize("env", [None, "local"])