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

Content wider than page (Google search reported issues) #750

Closed
halkeye opened this issue Jul 3, 2021 · 7 comments
Closed

Content wider than page (Google search reported issues) #750

halkeye opened this issue Jul 3, 2021 · 7 comments

Comments

@halkeye
Copy link
Member

halkeye commented Jul 3, 2021

image

@Chandu-4444
Copy link

Hey, Can I work on this issue? I'm a beginner and a few guidelines would help me a lot!

@MarkEWaite
Copy link
Contributor

MarkEWaite commented Jul 22, 2021

Thanks for your interest @Chandu-4444 . Yes, you can help. In the case of those two pages, the likely cause of the content being wider than the page is probably that the markdown or asciidoc documentation for the specific plugin is using some content that is wider than necessary.

https://github.com/jenkinsci/perfecto-plugin#readme shows a horizontal scroll bar for one of its examples and one or more of the images render very poorly on plugins.jenkins.io. A pull request to https://github.com/jenkinsci/perfecto-plugin/blob/master/README.md seems like the most likely way to resolve the "page too wide" warning on that plugin.

The same seems to be the case for https://github.com/jenkinsci/pipeline-maven-plugin#readme . It includes examples that need line breaks inserted so that they do not require horizontal scrolling to read the full text of the example.

It appears that @zbynek has already submitted the pull request for pipeline-maven plugin. See jenkinsci/pipeline-maven-plugin#348 . You could do the same type of thing for the perfecto plugin

@zbynek
Copy link
Contributor

zbynek commented Jul 22, 2021

@Chandu-4444 you can open the page on your phone or in Chrome dev tools in the mobile view -- you will see that the whole page https://github.com/jenkinsci/pipeline-maven-plugin#readme is scrollable horizontally, which is bad for navigation. My PR will improve it but maybe not fix it. The problem is with table formatting: I guess we need max-width and overflow-y:auto for tables. You can compare the README rendering on github and plugins.jenkins.io to get some more precise ideas. Also if we're touching formatting of tables, we should probably add some border to the cells and avoid the aggressive word-wrapping that you can see here: https://plugins.jenkins.io/csp/. A PR for https://github.com/jenkins-infra/plugin-site/blob/master/src/styles/base.css would be appreciated. I think the easiest way to verify your fix is to check the Lighthouse report in Chrome dev tools for mobile app, in particular the progressive web app section. For maven pipeline I can see this:
image

For the perfecto plugin I'm not sure what's the problem, I don't get horizontal scrolling for the whole page and I don't think horizontal scrolling for indivisual elements (like the code sample) is a problem, the lighthouse check is also passing. May be a false positive from Google? Anyway @MarkEWaite is right that the images on that page look bad, the easy solution is to avoid specifying the dimensions and let GitHub / plugin page figure it out based on the resolution, so a PR for perfecto readme is needed.

@Chandu-4444
Copy link

Chandu-4444 commented Jul 24, 2021

Thanks for the information @zbynek and @MarkEWaite. I'll modify those images at perfecto readme.

@aheritier
Copy link

@zbynek PR merged. Thx a lot

@zbynek
Copy link
Contributor

zbynek commented Aug 24, 2022

@halkeye there were 2 PRs merged, so I'm closing this. If you still see these issues in Webmaster console, maybe they can be gathered in #844 (?)

@zbynek zbynek closed this as completed Aug 24, 2022
@halkeye
Copy link
Member Author

halkeye commented Aug 24, 2022

image

google says we are good right now. I'll update 844 if there's new alerts

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants