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

Update docs css to point to shared location #3205 #3206

Closed
wants to merge 21 commits into from

Conversation

stichbury
Copy link
Contributor

NOTE: Kedro datasets are moving from kedro.extras.datasets to a separate kedro-datasets package in
kedro-plugins repository. Any changes to the dataset implementations
should be done by opening a pull request in that repository.

Description

Mirrors changes in Viz docs

Development notes

Removed CSS files and pointed to S3 location. Added code for meganav

Developer Certificate of Origin

We need all contributions to comply with the Developer Certificate of Origin (DCO). All commits must be signed off by including a Signed-off-by line in the commit message. See our wiki for guidance.

If your PR is blocked due to unsigned commits, then you must follow the instructions under "Rebase the branch" on the GitHub Checks page for your PR. This will retroactively add the sign-off to all unsigned commits and allow the DCO check to pass.

Checklist

  • Read the contributing guidelines
  • Signed off each commit with a Developer Certificate of Origin (DCO)
  • Opened this PR as a 'Draft Pull Request' if it is work-in-progress
  • Updated the documentation to reflect the code changes
  • Added a description of this change in the RELEASE.md file
  • Added tests to cover my changes
  • Checked if this change will affect Kedro-Viz, and if so, communicated that with the Viz team

Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
@stichbury stichbury added the Component: Documentation 📄 Issue/PR for markdown and API documentation label Oct 19, 2023
@stichbury stichbury self-assigned this Oct 19, 2023
@vladimir-mck vladimir-mck mentioned this pull request Oct 20, 2023
7 tasks
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
@stichbury
Copy link
Contributor Author

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

This is currently what the documentation looks like on desktop and mobile:
Screenshot 2023-10-31 at 14 04 23
Screenshot 2023-10-31 at 12 38 15
Screenshot 2023-10-31 at 12 38 23

The desktop version is fine (just need to make sure the nav is consistent when the user clicks on a navigation item). The mobile version needs more work, as you can see above the mobile menu interaction is a little strange.

I've created a quick design mockup below to illustrate expectations for mobile. Designs here.

Changes proposed for mobile:

  • update logo and menu icon
  • check font sizes and weights
  • include breadcrumb
  • fix mobile menu
    • menu icon location, close button icon
    • menu full width
    • logo position
    • navigation items in menu (Kedro, Kedro-Viz, Kedro-Datasets)
Docs - Wireframe v1-MobileLanding Docs - Wireframe v1-MobileMenu

Additional changes for desktop (only if easy to change as further docs redesign will come later):

  • reduce logo size
  • navigation items positioning
  • navigation items active-state cell size
  • navigation items active-state cell colour (change orange to black)
  • navigation items hover-state cell colour
  • reduce size of breadcrumb
Docs - Wireframe v1-Desktop

If changing the active-state colour from orange to black is too much effort, here is the orange version below. Please make sure the colour is the same across mobile as well.

Docs - Desktop-Orange

@stichbury
Copy link
Contributor Author

This is great, thank you!

@vladimir-mck This is feedback for you and feel free to work on this branch.

stichbury and others added 7 commits October 31, 2023 15:45
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Signed-off-by: Vladimir <vladimir_nikolic@external.mckinsey.com>
Signed-off-by: vladimir-mck <106236933+vladimir-mck@users.noreply.github.com>
Signed-off-by: vladimir-mck <106236933+vladimir-mck@users.noreply.github.com>
Signed-off-by: vladimir-mck <106236933+vladimir-mck@users.noreply.github.com>
Signed-off-by: vladimir-mck <106236933+vladimir-mck@users.noreply.github.com>
@stichbury stichbury marked this pull request as ready for review November 7, 2023 11:53
@stichbury
Copy link
Contributor Author

I'm not massively happy about adding a Kedro logo SVG file to the docs/source folder. If it isn't already, it should be on the https://github.com/kedro-org/kedro-brand-identity repo and referenced from there so it can be reused across the docs subprojects as needed.

@stichbury stichbury changed the title [Draft, not ready] Update docs css to point to shared location #3205 Update docs css to point to shared location #3205 Nov 7, 2023
@stephkaiser
Copy link

thank you for this @vladimir-mck! its looking really great - some design QA comments below:

  1. Navigation items font weight - doesn't look like Semi-Bold, it looks like Regular at the moment or Light (same on mobile)
Screenshot 2023-11-07 at 18 31 41
  1. Mobile menu scrolling - menu items and search bar should not be fixed for this version, enable full scrolling please.
  2. Kedro, Kedro-Viz, and Kedro-Datasets cells have more side padding compared to desktop version (compare with above screenshot), can we make them the same please?
Screenshot 2023-11-07 at 18 37 16
  1. Are we able to show breadcrumb on mobile as well?

  2. Are we able to reduce size of breadcrumb on desktop?

  3. Close menu icon is too thin, please use the icon from designs. I've attached it below and can also send it via Slack.
    PNG - IconShell-Close
    SVG - IconShell-Close

Screenshot 2023-11-07 at 18 39 38
  1. Left contents panel scrollbar - can we move it so it's aligned next to the divider line?
Screenshot 2023-11-07 at 18 41 53

Signed-off-by: vladimir-mck <106236933+vladimir-mck@users.noreply.github.com>
Signed-off-by: vladimir-mck <106236933+vladimir-mck@users.noreply.github.com>
vladimir-mck and others added 6 commits November 9, 2023 11:51
Signed-off-by: vladimir-mck <106236933+vladimir-mck@users.noreply.github.com>
Add correct links to subprojects

Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
@stichbury
Copy link
Contributor Author

Closing this as it's done and merged in a separate PR

@stichbury stichbury closed this Nov 13, 2023
@astrojuanlu astrojuanlu deleted the dev-update-docs-css branch November 13, 2023 16:47
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants