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

Parent task: Review most popular docs content and build a list of pages to update/cull/extend #2799

Closed
stichbury opened this issue Jul 17, 2023 · 2 comments
Assignees
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation Type: Parent Issue

Comments

@stichbury
Copy link
Contributor

stichbury commented Jul 17, 2023

Build a backlog of child tasks (pull out of existing backlog as needed) to drop into this milestone for execution.

As part of the process, look for ways to improve information architecture, by revising that hierarchy of navigation on the side panel if pages need to be combined or split or just moved.

@stichbury stichbury added Component: Documentation 📄 Issue/PR for markdown and API documentation Type: Parent Issue labels Jul 17, 2023
@stichbury
Copy link
Contributor Author

stichbury commented Jul 25, 2023

Most popular pages tend to be the get started and tutorial pages, plus the home page and search. However, of the content that does not cover on-boarding, these are the most visited sections:

  • /en/stable/data
  • /en/stable/notebooks_and_ipython
  • /en/stable/nodes_and_pipelines
  • /en/stable/visualisation
  • /en/stable/kedro_project_setup
  • /en/stable/configuration
  • /en/stable/experiment_tracking
  • /en/stable/hooks
  • /en/stable/logging
  • /en/stable/extend_kedro

This is also a popular page (but the rest of the section is not):

  • /en/stable/development/commands_reference.html

I'll focus on these initially.

Child tasks

@stichbury
Copy link
Contributor Author

I've created the child tickets for this ticket based on analysis of most popular pages. So I'm closing this parent now. None of the work to improve the pages will happen until we release 0.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 Type: Parent Issue
Projects
Archived in project
Development

No branches or pull requests

1 participant