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

Show link to docs on a build #3446

Merged
merged 3 commits into from Mar 23, 2018
Merged

Conversation

stsewd
Copy link
Member

@stsewd stsewd commented Dec 23, 2017

This PR is related to readthedocs/ext-theme#278 and #2469

For now, I trying to solve this:

If we're on a build, use the build version for the view docs link! This gets me every time

I think the View Docs button must remain the same on all the project area, otherwise it would be confusing.

I don't know much css, so any feedback is more than welcome :).

Here is how it looks right now

build-fail
build-progress
build-success

And how it will looks like after merging

build-fail
build-progress
build-success

This is still very WIP, so any feedback and suggestion is welcome!

Build #{{ build_id }}
{% endblocktrans %}
</span>

Copy link
Member Author

Choose a reason for hiding this comment

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

I don't know how to do this on a better way, what js library are you using?

Copy link
Member

Choose a reason for hiding this comment

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

Knockout I believe.

@stsewd
Copy link
Member Author

stsewd commented Dec 23, 2017

Hope I didn't break any other parts with the css change.

@RichardLitt RichardLitt added the PR: work in progress Pull request is not ready for full review label Dec 27, 2017
Copy link
Member

@ericholscher ericholscher left a comment

Choose a reason for hiding this comment

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

Looks good to me in local testing. Will let @agjohnson comment on the HTML/JS stuff.

Build #{{ build_id }}
{% endblocktrans %}
</span>

Copy link
Member

Choose a reason for hiding this comment

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

Knockout I believe.

@humitos
Copy link
Member

humitos commented Dec 29, 2017

This is a very personal opinion and so probably not that relevant

I think that with this change we are loosing some visual strengh impact on the status of the build when changing the red/green square by colorizing just the text Build readthedocs/readthedocs.org#111 with red/green.

I'd like to have the link view docs next to the old green square, instead of changing the structure.

Something like this:

my

@agjohnson
Copy link
Contributor

Visually, I prefer the change that @humitos suggests as well.

Alternatively, the view docs link would also fit in the right float area nicely. My vote would be for adding the link to this section.

My original thought is that we'd repurpose the main View Docs button, as it is really confusing that it always points to the same branch. This is another option.

Copy link
Contributor

@agjohnson agjohnson left a comment

Choose a reason for hiding this comment

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

From the technical side, these changes looks good 👍

The changes to revert the styling to the old UI will likely revert a lot of these additions however.

@stsewd
Copy link
Member Author

stsewd commented Jan 9, 2018

I reverted the other changes and put the link to the right as @agjohnson suggest

On building state

1

No staff user

3

Staff user

2

Copy link
Member

@humitos humitos left a comment

Choose a reason for hiding this comment

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

I like this new proposal!

@humitos humitos added PR: ready for review and removed PR: work in progress Pull request is not ready for full review labels Feb 15, 2018
@agjohnson agjohnson merged commit 2d6d2a0 into readthedocs:master Mar 23, 2018
@stsewd stsewd deleted the show-link-to-docs branch March 23, 2018 19:18
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.

None yet

5 participants