Skip to content

[Docs] Merge Diataxis reorg feature branch into main#5669

Open
stichbury wants to merge 11 commits into
mainfrom
docs/diataxis-iA
Open

[Docs] Merge Diataxis reorg feature branch into main#5669
stichbury wants to merge 11 commits into
mainfrom
docs/diataxis-iA

Conversation

@stichbury

@stichbury stichbury commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

Description

Over a period of several weeks, @rashidakanchwala and I have reorganised the Configuration and Data Catalog docs to fit the Diataxis pattern (concept pages plus separate how-to pages), and I have tidied the top-level nav so section labels read as topics rather than imperative verbs.

  • Configuration (Reorganize Configuration docs following Diataxis framework #5513, [Docs] Rename config explanation docs filenames (back to original names) #5620): retired parameters.md, credentials.md, advanced_configuration.md, and parameter_validation.md. New concept pages: parameters_and_credentials.md, templating.md. New how-to pages: how_to_configure_project.md, how_to_use_parameters_and_credentials.md, how_to_use_templating.md.
  • Data Catalog ([Docs] Reorg datacatalog docs for Diataxis framework #5622): trimmed the concept pages, extracted how-tos (how_to_configure_the_data_catalog.md, how_to_use_dataset_factories.md, how_to_use_partitioned_and_incremental_datasets.md, how_to_access_the_data_catalog_in_code.md), added an introduction landing page.
  • Nav labels: Configure → Configuration, Develop → Development, Deploy → Deployment, Extend → Extend a project, Create → Create projects, Catalog Data → Data Catalog, Build → Nodes & Pipelines; the one-page Inspect section folded into Development.
  • Plus a handful of child-label tweaks — most usefully Programmatic usage → Kedro sessions, Reusing pipelines (namespaces) → Namespaces, and dropping redundant Kedro / How to prefixes.
    All file removals and renames are covered by existing redirect_maps entries in mkdocs.yml.

Development notes

Rebuilds cleanly and tested by visual inspection. The built docs are here.

Developer Certificate of Origin

We need all contributions to comply with the Developer Certificate of Origin (DCO). All commits must be signed off by including a Signed-off-by line in the commit message. See our wiki for guidance.

If your PR is blocked due to unsigned commits, then you must follow the instructions under "Rebase the branch" on the GitHub Checks page for your PR. This will retroactively add the sign-off to all unsigned commits and allow the DCO check to pass.

Checklist

  • Read the contributing guidelines
  • Signed off each commit with a Developer Certificate of Origin (DCO)
  • Opened this PR as a 'Draft Pull Request' if it is work-in-progress
  • Updated the documentation to reflect the code changes
  • Added a description of this change in the RELEASE.md file
  • Added tests to cover my changes
  • Checked if this change will affect Kedro-Viz, and if so, communicated that with the Viz team

rashidakanchwala and others added 11 commits June 2, 2026 13:55
* done

Signed-off-by: rashidakanchwala <rashida_kanchwala@mckinsey.com>

* changes based on reviews

Signed-off-by: rashidakanchwala <rashida_kanchwala@mckinsey.com>

* Exclude temporary Diataxis planning docs from Vale

These planning docs are removed before merge and only exist to help
reviewers track content moves, so they don't need to pass Vale style checks.

Co-authored-by: Cursor <cursoragent@cursor.com>
Signed-off-by: rashidakanchwala <rashida_kanchwala@mckinsey.com>

* Remove temporary Diataxis planning docs

These planning docs only existed to help reviewers track content moves
and are no longer needed. Also revert the now-unnecessary Vale exclusion.

Co-authored-by: Cursor <cursoragent@cursor.com>
Signed-off-by: rashidakanchwala <rashida_kanchwala@mckinsey.com>

* review-pr-skill 1

Signed-off-by: rashidakanchwala <rashida_kanchwala@mckinsey.com>

* Update .gitignore

Signed-off-by: rashidakanchwala <37628668+rashidakanchwala@users.noreply.github.com>

* fix vale

Signed-off-by: rashidakanchwala <rashida_kanchwala@mckinsey.com>

* Fix Vale sentencelength suggestions in new config docs

Signed-off-by: rashidakanchwala <rashida_kanchwala@mckinsey.com>
Co-authored-by: Cursor <cursoragent@cursor.com>

---------

Signed-off-by: rashidakanchwala <rashida_kanchwala@mckinsey.com>
Signed-off-by: rashidakanchwala <37628668+rashidakanchwala@users.noreply.github.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
…es) (#5620)

* Rollback filename change for explanation pages

Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>

* Update crosslinking within docs

Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>

* Update docs/catalog-data/data_catalog.md

Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>

---------

Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
* Revise data catalog pages to split into Diataxis sections

Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>

* Update FAQs to point to new link for data catalog docs

Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>

* Add shim heading on dataset factories concept page

Preserves the #how-to-override-the-default-dataset-creation-with-dataset-factories
anchor on the renamed-to-concept-only page so existing external links continue
to land on a matching heading. The shim points readers at the equivalent
section on the new how-to page.

RTD path-based redirects cannot rescue this anchor on their own because the
concept page still exists at its original URL.

Co-authored-by: Cursor <cursoragent@cursor.com>
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>

* Fix Vale findings in new prose

Splits three over-long intro sentences and replaces a weasel word in the
Data Catalog landing page. All four edits are on new prose added by the
restructure; the remaining Vale findings on the PR sit on pre-existing
content moved into the new files and are intentionally out of scope here.

Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Co-authored-by: Cursor <cursoragent@cursor.com>

* Vale fixes

Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Co-authored-by: Cursor <cursoragent@cursor.com>

* Vale fixes

Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Co-authored-by: Cursor <cursoragent@cursor.com>

* Update mkdocs.yml

* Update mkdocs.yml

Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>

---------

Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
@stichbury stichbury self-assigned this Jul 16, 2026
@stichbury stichbury added the Component: Documentation 📄 Issue/PR for markdown and API documentation label Jul 16, 2026
@stichbury
stichbury marked this pull request as ready for review July 16, 2026 12:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Component: Documentation 📄 Issue/PR for markdown and API documentation

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

2 participants