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] Docs mega nav #3168

Closed
wants to merge 16 commits into from
Closed

[DRAFT] Docs mega nav #3168

wants to merge 16 commits into from

Conversation

vladimir-mck
Copy link

@vladimir-mck vladimir-mck commented Oct 12, 2023

Description

This PR was created as a first step to creating a global navigation for docs as per #3024

Development notes

  • Pull the branch
  • Build and & start the docs

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

@datajoely
Copy link
Contributor

No comment other than rad PR title

@stichbury
Copy link
Contributor

stichbury commented Oct 12, 2023

This is great, thanks @vladimir-mck!

Built docs are here for people wanting a preview: https://kedro--3168.org.readthedocs.build/en/3168/#

I'm not sure how much review you want at this as it's in draft, but I've added @stephkaiser and @tynandebold here for visibility and their thoughts.

From my side, some basic comments:

  • We won't need the "Deployment" section for now -- only Framework, Viz and Datasets.
  • Please can you title them as "Kedro" "Kedro-Viz" and "Kedro-Datasets" (to align their naming with what's on https://pypi.org
  • I'm not sure whether this is related but in the preview build, I can't scroll to the bottom of the table of contents to see the kedro_datasets API docs, whereas I can in the stable docs. It may be nothing to do with your changes but I wanted to flag it.

@astrojuanlu astrojuanlu marked this pull request as draft October 17, 2023 15:40
@astrojuanlu
Copy link
Member

Marking this as a draft, feel free to mark it as ready for review whenever you want @vladimir-mck 👍🏽 The style changes are looking good so far!

@stichbury
Copy link
Contributor

@vladimir-mck I've changed the base branch to develop as we are working over there now.

@vladimir-mck
Copy link
Author

Closing this PR, it will be handled with this one

@merelcht merelcht deleted the docs/meganav branch October 25, 2023 12:11
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.

4 participants