Revise Viz docs content to add intersphinx linking #1628

stichbury · 2023-11-08T11:15:33Z

Description

Twin to the Framework PR kedro-org/kedro#3283 which links Viz back to the Framework subproject. Note that this PR also contains the changes to layout.html to fold in the new meganav and CSS changes for docs subprojects.

I've left a couple of links that point to permalinks for subheads rather than pages, since we cannot fix those at present kedro-org/kedro#3289 but otherwise this is nicely decoupled.

Also revised the permalink symbol for each subhead anchor and made a minor copy change.

Ready for Viz team review.

Development notes

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

Signed-off-by: Jo Stichbury <[email protected]>

Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>

Signed-off-by: Jo Stichbury <[email protected]>

into viz-docs-update

stichbury · 2023-11-08T12:15:33Z

One thing left to do here is to hook up the docs build to the automated Viz build system and RTD, plus any final checks to add like docs linting. Probably something to ask @astrojuanlu or @SajidAlamQB to look at.

Signed-off-by: Jo Stichbury <[email protected]>

) * Update docs front page Signed-off-by: Jo Stichbury <[email protected]> * Remove nav_version next to Kedro logo in top left; add Kedro logo Signed-off-by: Tynan DeBold <[email protected]> * Revise project name and author name Signed-off-by: Jo Stichbury <[email protected]> * Use full kedro icon and type for logo Signed-off-by: Tynan DeBold <[email protected]> * Add mobile nav close btn * Move code for adding btn to event listener * Add css for mobile nav image background * Update close button for mobile nav --------- Signed-off-by: Jo Stichbury <[email protected]> Signed-off-by: Tynan DeBold <[email protected]> Co-authored-by: Tynan DeBold <[email protected]> Co-authored-by: Vladimir <[email protected]> Co-authored-by: vladimir-mck <[email protected]>

Signed-off-by: Jo Stichbury <[email protected]>

Add datasets subproject link

…lling. (#1631) * Update shareable viz docswith sections on creating access key and billing Signed-off-by: Nero Okwa <[email protected]> * Update docs/source/share_kedro_viz.md Co-authored-by: Tynan DeBold <[email protected]> * Update docs/source/share_kedro_viz.md Co-authored-by: Tynan DeBold <[email protected]> * Update docs/source/share_kedro_viz.md Co-authored-by: Tynan DeBold <[email protected]> * Update docs/source/share_kedro_viz.md Co-authored-by: Tynan DeBold <[email protected]> * Update docs/source/share_kedro_viz.md Co-authored-by: Tynan DeBold <[email protected]> * Update docs/source/share_kedro_viz.md Co-authored-by: Tynan DeBold <[email protected]> * Update docs/source/share_kedro_viz.md Co-authored-by: Tynan DeBold <[email protected]> * Update share_kedro_viz.md --------- Signed-off-by: Nero Okwa <[email protected]> Co-authored-by: Tynan DeBold <[email protected]> Co-authored-by: Jo Stichbury <[email protected]>

astrojuanlu

This is looking good! Left a few comments

docs/source/conf.py

astrojuanlu · 2023-11-09T22:54:16Z

docs/source/experiment_tracking.md


 ## Set up a project

-This section describes the steps necessary to set up experiment tracking and access logged metrics, using the [spaceflights tutorial](https://docs.kedro.org/en/stable/tutorial/spaceflights_tutorial.html) with a version of Kedro equal to or higher than 0.18.4, and a version of Kedro-Viz equal to or higher than 5.2.
+This section describes the steps necessary to set up experiment tracking and access logged metrics, using the {doc}`spaceflights tutorial<kedro:tutorial/spaceflights_tutorial>` with a version of Kedro equal to or higher than 0.18.4, and a version of Kedro-Viz equal to or higher than 5.2.


I noticed that all these {doc} references are opened in a new window, is that on purpose?

It wasn't 😆 although I'm asked for it often enough and I think it's quite a reasonable thing to do. How to control this?

It's a good question 😅 I'll do some digging

docs/source/experiment_tracking.md

docs/source/preview_datasets.md

docs/source/share_kedro_viz.md

docs/source/visualise_charts_with_matplotlib.md

docs/source/visualise_charts_with_plotly.md

docs/source/conf.py

Co-authored-by: Juan Luis Cano Rodríguez <[email protected]>

Signed-off-by: Jo Stichbury <[email protected]>

into viz-docs-update

stichbury · 2023-11-10T10:32:34Z

@astrojuanlu Thanks for the review. Couple of comments left for you but also I intend to revisit these soon to revise for the add-ons/starters changes coming on 0.19 so there will be another bunch of fixes and a separate "Set up Viz" page in the near future.

astrojuanlu

Honestly I think this is good enough to get in! We can iterate later, it's important to close the loop

rashidakanchwala

@stichbury, I haven't done a thorough content review as you said it's the same.
Overall, the structure looks great. Thank you

docs/source/kedro-viz_visualisation.md

tynandebold

Amazing work!

Signed-off-by: Jo Stichbury <[email protected]>

stichbury and others added 4 commits November 8, 2023 11:14

something to start off

f7d9aea

Signed-off-by: Jo Stichbury <[email protected]>

Fix permalink icon

5960089

Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>

Revise some links to framework docs

c030361

Signed-off-by: Jo Stichbury <[email protected]>

Merge branch 'viz-docs-update' of https://github.com/kedro-org/kedro-viz

a442790

into viz-docs-update

stichbury changed the title ~~[draft] Revise Viz docs content to add intersphinx linking~~ Revise Viz docs content to add intersphinx linking Nov 8, 2023

stichbury self-assigned this Nov 8, 2023

stichbury requested a review from NeroOkwa November 8, 2023 12:13

stichbury marked this pull request as ready for review November 8, 2023 12:14

stichbury requested review from tynandebold, yetudada and rashidakanchwala as code owners November 8, 2023 12:14

stichbury mentioned this pull request Nov 8, 2023

[Draft, not ready] Update docs front page following design review #1617

Merged

5 tasks

stichbury and others added 10 commits November 8, 2023 14:03

Add live tracking demo to open in new tab

329caf1

Signed-off-by: Jo Stichbury <[email protected]>

Remove code to load old CSS

ebba904

Signed-off-by: Jo Stichbury <[email protected]>

A few content improvements

945e1e1

Signed-off-by: Jo Stichbury <[email protected]>

Update layout.html

c1d7ad9

Update layout.html

eaed0d0

Delete docs/source/kedro-horizontal-color-on-light.svg

9fbea4c

Update conf.py

b2e67bf

Update layout.html

ddc8ec5

Add datasets subproject link

astrojuanlu reviewed Nov 9, 2023

View reviewed changes

stichbury commented Nov 10, 2023

View reviewed changes

docs/source/conf.py Outdated Show resolved Hide resolved

stichbury and others added 5 commits November 10, 2023 10:19

Update docs/source/conf.py

5929057

Update docs/source/preview_datasets.md

7c94911

Co-authored-by: Juan Luis Cano Rodríguez <[email protected]>

Update docs/source/visualise_charts_with_matplotlib.md

5c30d85

Co-authored-by: Juan Luis Cano Rodríguez <[email protected]>

Update docs/source/share_kedro_viz.md

d65db3c

Co-authored-by: Juan Luis Cano Rodríguez <[email protected]>

Update docs/source/visualise_charts_with_plotly.md

7a45793

Co-authored-by: Juan Luis Cano Rodríguez <[email protected]>

stichbury requested a review from astrojuanlu November 10, 2023 10:29

stichbury and others added 4 commits November 10, 2023 10:30

Update docs/source/preview_datasets.md

667fc94

Co-authored-by: Juan Luis Cano Rodríguez <[email protected]>

Merge branch 'main' into viz-docs-update

830d462

Suggested variable removal

4b8e914

Signed-off-by: Jo Stichbury <[email protected]>

Merge branch 'viz-docs-update' of https://github.com/kedro-org/kedro-viz

9ad1646

into viz-docs-update

stichbury mentioned this pull request Nov 10, 2023

Parent task: Set up subprojects for Kedro-Viz and kedro-datasets docs kedro-org/kedro#2600

Closed

astrojuanlu approved these changes Nov 10, 2023

View reviewed changes

rashidakanchwala approved these changes Nov 13, 2023

View reviewed changes

rashidakanchwala reviewed Nov 13, 2023

View reviewed changes

docs/source/kedro-viz_visualisation.md Outdated Show resolved Hide resolved

tynandebold approved these changes Nov 13, 2023

View reviewed changes

NeroOkwa approved these changes Nov 13, 2023

View reviewed changes

Fix links

5e471d6

Signed-off-by: Jo Stichbury <[email protected]>

stichbury merged commit a38770b into main Nov 13, 2023
5 checks passed

stichbury deleted the viz-docs-update branch November 13, 2023 12:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Revise Viz docs content to add intersphinx linking #1628

Revise Viz docs content to add intersphinx linking #1628

stichbury commented Nov 8, 2023 •

edited by tynandebold

Loading

stichbury commented Nov 8, 2023

astrojuanlu left a comment

astrojuanlu Nov 9, 2023

stichbury Nov 10, 2023

astrojuanlu Nov 10, 2023

stichbury commented Nov 10, 2023

astrojuanlu left a comment

rashidakanchwala left a comment

tynandebold left a comment

Revise Viz docs content to add intersphinx linking #1628

Revise Viz docs content to add intersphinx linking #1628

Conversation

stichbury commented Nov 8, 2023 • edited by tynandebold Loading

Description

Development notes

QA notes

Checklist

stichbury commented Nov 8, 2023

astrojuanlu left a comment

Choose a reason for hiding this comment

astrojuanlu Nov 9, 2023

Choose a reason for hiding this comment

stichbury Nov 10, 2023

Choose a reason for hiding this comment

astrojuanlu Nov 10, 2023

Choose a reason for hiding this comment

stichbury commented Nov 10, 2023

astrojuanlu left a comment

Choose a reason for hiding this comment

rashidakanchwala left a comment

Choose a reason for hiding this comment

tynandebold left a comment

Choose a reason for hiding this comment

stichbury commented Nov 8, 2023 •

edited by tynandebold

Loading