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

Enhance Kedro-viz doc integration process #1637

Closed
3 tasks
stichbury opened this issue Nov 13, 2023 · 1 comment · Fixed by #1874
Closed
3 tasks

Enhance Kedro-viz doc integration process #1637

stichbury opened this issue Nov 13, 2023 · 1 comment · Fixed by #1874
Assignees
Labels
Documentation Python Pull requests that update Python code

Comments

@stichbury
Copy link
Contributor

stichbury commented Nov 13, 2023

Description

The outcome of kedro-org/kedro#2600 is that Viz now has its own docs in this repository.

That means that the engineers working on Viz now have responsibility for them, and as part of handover, there are a few tasks that you'll need to pick up and complete, with guidance from Framework.

Tasks

  • Update continuous integration to run a linter across the Viz docs
  • Update GitHub actions to run the Vale "language linter" on changes to the Viz docs (@ankatiyar is well-placed to help with this as she worked on the Framework docs)
  • Revise the way the project initiates and runs a Sphinx build to more closely follow the Framework approach with a build-docs.sh that is initiated from a makefile. At present we run make html created by Sphinx.

cc @rashidakanchwala

@rashidakanchwala rashidakanchwala changed the title Viz docs handover tasks Enhance Kedro-viz doc intergration process Nov 20, 2023
@rashidakanchwala rashidakanchwala added the Python Pull requests that update Python code label Nov 20, 2023
@rashidakanchwala rashidakanchwala changed the title Enhance Kedro-viz doc intergration process Enhance Kedro-viz doc integration process Nov 20, 2023
@astrojuanlu
Copy link
Member

Adding making use of https://github.com/kedro-org/kedro-sphinx-theme for consistency

Essentially doing the equivalent of kedro-org/kedro#3675

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Python Pull requests that update Python code
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

5 participants