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

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

Merged
merged 13 commits into from
Nov 8, 2023

Conversation

stichbury
Copy link
Contributor

@stichbury stichbury commented Oct 31, 2023

Description

This PR forms part of the ongoing work to enable a documentation subproject for Kedro-Viz. See #1524 for more details (and the kedro-org/kedro#2600).

Development notes

Updated the docs front page following design review in #1592.

  • Added graphic used by README.md on the repo
  • Revised an emoji
  • Added a link to the live demo
  • Changes to the top left corner from @tynandebold

Currently waiting to make a final chunk of changes to align this PR with meganav improvements as suggested by Steph in design review. So this is not yet ready to merge.

QA notes

Rebuilt docs and inspected

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 <jo_stichbury@mckinsey.com>
tynandebold and others added 5 commits October 31, 2023 12:07
Signed-off-by: Tynan DeBold <thdebold@gmail.com>
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Signed-off-by: Tynan DeBold <thdebold@gmail.com>
…/kedro-viz into update-docs-front-page

Signed-off-by: Tynan DeBold <thdebold@gmail.com>
@stichbury stichbury marked this pull request as ready for review November 1, 2023 15:52
@stichbury stichbury marked this pull request as draft November 1, 2023 15:55
Copy link
Member

@tynandebold tynandebold left a comment

Choose a reason for hiding this comment

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

Looking great. Three comments from me, none of which I consider to be blocking, so I'll approve now.

docs/source/index.md Show resolved Hide resolved
docs/source/index.md Outdated Show resolved Hide resolved
docs/source/conf.py Outdated Show resolved Hide resolved
@stichbury stichbury changed the base branch from main to viz-docs-update November 8, 2023 14:09
@stichbury stichbury marked this pull request as ready for review November 8, 2023 14:11
@stichbury
Copy link
Contributor Author

I'm closing this PR by merging it into my other changes in #1628.

@stichbury stichbury merged commit 44bec27 into viz-docs-update Nov 8, 2023
2 of 4 checks passed
@stichbury stichbury deleted the update-docs-front-page branch November 8, 2023 14:12
stichbury added a commit that referenced this pull request Nov 13, 2023
* something to start off

Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>

* Fix permalink icon

Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>

* Revise some links to framework docs

Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>

* Add live tracking demo to open in new tab

Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>

* Remove code to load old CSS

Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>

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

* Update docs front page

Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>

* Remove nav_version next to Kedro logo in top left; add Kedro logo

Signed-off-by: Tynan DeBold <thdebold@gmail.com>

* Revise project name and author name

Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>

* Use full kedro icon and type for logo

Signed-off-by: Tynan DeBold <thdebold@gmail.com>

* 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 <jo_stichbury@mckinsey.com>
Signed-off-by: Tynan DeBold <thdebold@gmail.com>
Co-authored-by: Tynan DeBold <thdebold@gmail.com>
Co-authored-by: Vladimir <vladimir_nikolic@external.mckinsey.com>
Co-authored-by: vladimir-mck <106236933+vladimir-mck@users.noreply.github.com>

* A few content improvements

Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>

* Update layout.html

* Update layout.html

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

* Update conf.py

* Update layout.html

Add datasets subproject link

* Update Shareable Viz docs with sections on creating access key and billing. (#1631)

* Update shareable viz docswith sections on creating access key and billing

Signed-off-by: Nero Okwa <50266242+NeroOkwa@users.noreply.github.com>

* Update docs/source/share_kedro_viz.md

Co-authored-by: Tynan DeBold <thdebold@gmail.com>

* Update docs/source/share_kedro_viz.md

Co-authored-by: Tynan DeBold <thdebold@gmail.com>

* Update docs/source/share_kedro_viz.md

Co-authored-by: Tynan DeBold <thdebold@gmail.com>

* Update docs/source/share_kedro_viz.md

Co-authored-by: Tynan DeBold <thdebold@gmail.com>

* Update docs/source/share_kedro_viz.md

Co-authored-by: Tynan DeBold <thdebold@gmail.com>

* Update docs/source/share_kedro_viz.md

Co-authored-by: Tynan DeBold <thdebold@gmail.com>

* Update docs/source/share_kedro_viz.md

Co-authored-by: Tynan DeBold <thdebold@gmail.com>

* Update share_kedro_viz.md

---------

Signed-off-by: Nero Okwa <50266242+NeroOkwa@users.noreply.github.com>
Co-authored-by: Tynan DeBold <thdebold@gmail.com>
Co-authored-by: Jo Stichbury <jo_stichbury@mckinsey.com>

* Update docs/source/conf.py

* Update docs/source/preview_datasets.md

Co-authored-by: Juan Luis Cano Rodríguez <hello@juanlu.space>

* Update docs/source/visualise_charts_with_matplotlib.md

Co-authored-by: Juan Luis Cano Rodríguez <hello@juanlu.space>

* Update docs/source/share_kedro_viz.md

Co-authored-by: Juan Luis Cano Rodríguez <hello@juanlu.space>

* Update docs/source/visualise_charts_with_plotly.md

Co-authored-by: Juan Luis Cano Rodríguez <hello@juanlu.space>

* Update docs/source/preview_datasets.md

Co-authored-by: Juan Luis Cano Rodríguez <hello@juanlu.space>

* Suggested variable removal

Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>

* Fix links

Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>

---------

Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
Signed-off-by: Tynan DeBold <thdebold@gmail.com>
Signed-off-by: Nero Okwa <50266242+NeroOkwa@users.noreply.github.com>
Co-authored-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
Co-authored-by: Tynan DeBold <thdebold@gmail.com>
Co-authored-by: Vladimir <vladimir_nikolic@external.mckinsey.com>
Co-authored-by: vladimir-mck <106236933+vladimir-mck@users.noreply.github.com>
Co-authored-by: Nero Okwa <50266242+NeroOkwa@users.noreply.github.com>
Co-authored-by: Juan Luis Cano Rodríguez <hello@juanlu.space>
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.

3 participants