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

Extend FAQ documentation to add configuration Q&A pairs #2503

Merged
merged 3 commits into from
Apr 12, 2023

Conversation

stichbury
Copy link
Contributor

@stichbury stichbury commented Apr 11, 2023

NOTE: Kedro datasets are moving from kedro.extras.datasets to a separate kedro-datasets package in
kedro-plugins repository. Any changes to the dataset implementations
should be done by opening a pull request in that repository.

Built docs are here

Description

In response to #2438 I have added links to "How to" Q&A pairs that were created for the configuration documentation.

This is all I'm doing in terms of FAQs right now.

There are other commonly answered questions but I'm going to raise issues to get these added to documentation separately as they arise, and some may be better included in the FAQ on the GitHub wiki for now, since that holds odds and ends of queries that don't fit within the docs.

Some, already known, are not docs issues such as dynamic pipelines, which highlight Kedro's philosophical stance so will be covered in a blog post.

Adding fix for missing permalink symbol

Thanks to @astrojuanlu there's a cherry-picked fix in here to add the missing symbol back to our permalinks.

Development notes

Linted, rebuilt locally, inspected docs.

Checklist

  • Read the contributing guidelines
  • 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

@stichbury stichbury self-assigned this Apr 11, 2023
@stichbury stichbury added the Component: Documentation 📄 Issue/PR for markdown and API documentation label Apr 11, 2023
Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>
@stichbury stichbury marked this pull request as ready for review April 11, 2023 13:51
@stichbury stichbury requested review from noklam and merelcht April 11, 2023 13:52
@stichbury stichbury changed the title [Draft] Extend FAQ documentation Extend FAQ documentation to add configuration Q&A pairs Apr 11, 2023
Copy link
Member

@merelcht merelcht left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 👍

Copy link
Member

@astrojuanlu astrojuanlu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:shipit:

@stichbury stichbury enabled auto-merge (squash) April 12, 2023 10:14
@stichbury stichbury disabled auto-merge April 12, 2023 11:04
Copy link
Contributor

@noklam noklam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! thanks!

@merelcht merelcht merged commit 9b20bfc into main Apr 12, 2023
@merelcht merelcht deleted the 2438-add-config-Q&A branch April 12, 2023 17:19
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
None yet
Development

Successfully merging this pull request may close these issues.

4 participants