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

Add Visit docs button to header #508

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Conversation

ericholscher
Copy link
Member

@ericholscher ericholscher commented Oct 15, 2024

This gives a basic way to get to the docs like the old dashboard. I was doing a bunch of local dev on the new dashboard and kept getting annoyed at not being able to get to the docs in an obvious way.

I think this is important and is a middle ground until we can work on a fancier verison.

Screenshot 2024-10-15 at 7 21 13 AM

This gives a basic way to get to the docs like the old dashboard.

I think this is important and is a middle ground until we can work on a fancier verison.
@ericholscher ericholscher requested a review from a team as a code owner October 15, 2024 14:20
@agjohnson
Copy link
Contributor

The reason I have been -1 on this approach is because it creates two view docs buttons on the build detail page. The top most button will go to the wrong docs too (latest) instead of the PR build/branch docs for the build.

I still think this should be a singular button

@agjohnson
Copy link
Contributor

agjohnson commented Oct 15, 2024

This button will eventually move to the project wide header, here:

A temporary solution until someone wants to make this into a dropdown would be to move the current view docs button in the build detail page up to a {% block project_header_navigation_docs %} and override this blck on the build detail page. However, due to how this is included, this is not straight forward. This way at least a singe button doesn't make for bad UX on the build detail page and it points to a reasonable version on all of the project pages.

I still feel a dropdown is the best UX here and is my overall goal still.

@ericholscher
Copy link
Member Author

For now, I've just hidden the View docs button on build pages, which seems like a reasonable approach?

@agjohnson
Copy link
Contributor

We talked through this one in person, I mentioned:

  • The top latest view docs button needs to react to the project not having a successful build
  • The lower view docs should move up, so there is one button. However, this button state is driven by the surrounding KO view and build detail API response.
  • The current, per-version view docs button also needs to react to build status, so can't be a simple link either

The answer here does need to be more complex. A web component fits here short and long term, I'm poking something more flexible now.

@ericholscher
Copy link
Member Author

I think this is still worth getting in, especially now that we are pointing folks to this. I think my current PR solves this problem in a simple way for now, and we can do the v2 later when we have more time to dive into it?

@ericholscher
Copy link
Member Author

Ping @agjohnson -- 👍 on shipping this simple version for now, and we can work to make it the better smart version in the future?

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.

2 participants