-
Notifications
You must be signed in to change notification settings - Fork 338
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
Restructure docs folder and website for usability and clarity #4430
base: master
Are you sure you want to change the base?
Conversation
Signed-off-by: Daniel Tianqi Zhou <dzhou@redhat.com>
@@ -64,7 +64,16 @@ markdown_extensions: | |||
- toc: | |||
permalink: true | |||
nav: | |||
- Introduction: index.md | |||
- Getting Started: | |||
- Introduction: README.md |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
hold this change, its conflicting with https://github.com/ovn-org/ovn-kubernetes/pull/4333/files#diff-98d0f806abc9af24e6a7c545d3d77e8f9ad57643e27211d7a7b896113e420ed2 why is the index.md file getting removed like that? IMHO its better to remove the introduction bit from getting started..
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I renamed index.md to README.md so we could both include it in the nav bar and use it as the homepage
- Setup and Building: getting-started/building-ovn-kubernetes.md | ||
- Run OVN-Kubernetes From Release Image: getting-started/running-release.md | ||
- CLI Guide: getting-started/cli-guide.md | ||
- Configuration Guide: getting-started/configuration.md | ||
- Overview: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overview should be first, not sure why Getting started is moving positions here
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I had getting started in the first position because it contained the index/homepage for the project since I deleted the introduction subheading.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see, I don't think we need overview in getting started so we can keep things where they are in that case at least that's the change I had proposed in my PR for the release cut, but ofc I don't have strong opinions either ways.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I felt that it was better for UI simplification since right now the index page gets its own subheading, which seems a little wasteful. Maybe instead we can just remove the subheading and keep everything else where it is?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yeah that's the bit I did in my PR PTAL, if you rebase this we can have another round of reviews
the other thing I was thinking is.. is there any use to keep the deprecated docs at all? (thinking out loud here.. will ask team for second opinion on if we should probably just get rid of these ...)
This PR is stale because it has been open 90 days with no activity. Remove stale label or comment or reach out to maintainers for code reviews or consider closing this if you do not plan to work on it. |
What this PR does and why is it needed
Which issue(s) this PR fixes
Fixes #
Special notes for reviewers
Changed index.md to README.md. Tested with mkdocs and apparently using index.md instead of README.md means it will not properly be in a subheading in the website columns. Using README.md is workaround for that problem
How to verify it
Details to documentation updates
Instead of changing documentation mostly making sure documentation more accessible.
Description for the changelog
Refactored docs folder structure
Does this PR introduce a user-facing change?