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

Create a 'Best practices' documentation page under 'Get started' #1898

Closed
jmholzer opened this issue Oct 4, 2022 · 4 comments
Closed

Create a 'Best practices' documentation page under 'Get started' #1898

jmholzer opened this issue Oct 4, 2022 · 4 comments
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation Issue: Feature Request New feature or improvement to existing feature

Comments

@jmholzer
Copy link
Contributor

jmholzer commented Oct 4, 2022

Description

It would be good to have a new docs page under 'Get Started' that briefly introduces the reader to linting and testing. It should then point them to our new docs pages that are being written as a response to the tickets:

Context

This is an important step in deprecating kedro test and kedro lint. It gives more visibility to our new documentation, which is being written as an alternative to these commands.

@jmholzer jmholzer added Component: Documentation 📄 Issue/PR for markdown and API documentation Issue: Feature Request New feature or improvement to existing feature labels Oct 4, 2022
@stichbury
Copy link
Contributor

I'm not convinced that Get Started is the place for lint/test information as it's probably not the first thing a new user looks to do. We certainly need a section, but the location may need some further consideration.

@stichbury
Copy link
Contributor

I have tentatively added a section on best practice in Kedro projects to a "Kedro project setup" section in a newly reorganised docs (visible here). So this could potentially happen within the basis of that work (covered by #1989)

@stichbury
Copy link
Contributor

Also take a look at #1271 as a somewhat related issue

@stichbury
Copy link
Contributor

stichbury commented Jul 5, 2023

This is a duplicate of #1271

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 Issue: Feature Request New feature or improvement to existing feature
Projects
Status: Done
Development

No branches or pull requests

2 participants