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

Enhancement/doc-integration #1874

Merged
merged 22 commits into from
May 2, 2024
Merged

Enhancement/doc-integration #1874

merged 22 commits into from
May 2, 2024

Conversation

Huongg
Copy link
Contributor

@Huongg Huongg commented Apr 24, 2024

Description

Fixes #1637

Development notes

To enhance Kedro-viz current build to be more closely with Kedro Framework docs build, that includes:

  • Update continuous integration to run a linter across the Viz docs. This task includes:
    Setup docs-language-linter
    Setup docs-only-checks

  • Update GitHub actions to run the Vale "language linter" on changes to the Viz docs. This task includes:
    Setup vale.ini
    Reuse styles component set up by @stichbury for Kedro framework. This to be discussed with the wider team on how we can reuse this between framework and viz, as in even we might not change the styling very frequently, how about the names text ignore? Eg: if someone joins the team we will always have to remember to update them in 2 different places etc

  • 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. This task includes:
    Include Sphinx build in readthedocs.yml
    Follow build-docs.sh from Kedro framework

  • Add https://github.com/kedro-org/kedro-sphinx-theme for consistency for consistency with Framework
    To be done in a separate ticket. I've created the issue 1882 for us track

QA notes

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 new entries to the RELEASE.md file
  • Added tests to cover my changes

@Huongg Huongg marked this pull request as ready for review April 29, 2024 20:26
@Huongg Huongg changed the title [DRAFT] Enhancement/doc-integration Enhancement/doc-integration Apr 30, 2024
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.

In terms of DocOps this looks mostly identical to kedro-org/kedro for me, the RTD build seems happy, and the output for now is the same, so this looks good to me!

Just left one nitpick

.readthedocs.yml Outdated Show resolved Hide resolved
@Huongg Huongg self-assigned this Apr 30, 2024
Copy link
Contributor

@rashidakanchwala rashidakanchwala left a comment

Choose a reason for hiding this comment

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

Overall LGTM, and a very interesting PR; learned some good grammar and inclusive language practices for docs whilst reviewing.

If @astrojuanlu , and @ankatiyar are ok with the above. We can merge :D .. thanks @Huongg

Copy link
Contributor

@ankatiyar ankatiyar left a comment

Choose a reason for hiding this comment

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

Some minor changes but LGTM otherwise!

.github/styles/Kedro-viz/ignore-names.txt Outdated Show resolved Hide resolved
.github/styles/Kedro-viz/Spellings.yml Outdated Show resolved Hide resolved
.github/styles/Kedro-viz/Spellings.yml Outdated Show resolved Hide resolved
.github/workflows/docs-only-checks.yml Outdated Show resolved Hide resolved
.github/workflows/docs-only-checks.yml Outdated Show resolved Hide resolved
Huongg and others added 2 commits May 1, 2024 15:03
Co-authored-by: Ankita Katiyar <[email protected]>
Signed-off-by: Huong Nguyen <[email protected]>
Co-authored-by: Ankita Katiyar <[email protected]>
Signed-off-by: Huong Nguyen <[email protected]>
Huongg and others added 2 commits May 1, 2024 15:03
Co-authored-by: Ankita Katiyar <[email protected]>
Signed-off-by: Huong Nguyen <[email protected]>
Co-authored-by: Ankita Katiyar <[email protected]>
Signed-off-by: Huong Nguyen <[email protected]>
Copy link
Contributor

@ravi-kumar-pilla ravi-kumar-pilla left a comment

Choose a reason for hiding this comment

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

I do not have much knowledge on these changes. Looks quite intense grammar 🥇 .. Thank you for the PR @Huongg

Huongg and others added 5 commits May 2, 2024 10:45
Co-authored-by: Juan Luis Cano Rodríguez <[email protected]>
Signed-off-by: Huong Nguyen <[email protected]>
Signed-off-by: huongg <[email protected]>
…dro-viz into enhancement/doc-integration

Signed-off-by: huongg <[email protected]>
@Huongg Huongg merged commit dd3a989 into main May 2, 2024
43 checks passed
@Huongg Huongg deleted the enhancement/doc-integration branch May 2, 2024 11:20
This was referenced May 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enhance Kedro-viz doc integration process
5 participants