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

docs: use dropdown menu for selecting version #6559

Merged
merged 1 commit into from
Sep 3, 2021

Conversation

gsquared94
Copy link
Contributor

Fixes: #6442
This PR replaces the huge list of versions with a dropdown menu.

Before:

image

After:

image

@gsquared94 gsquared94 requested a review from a team as a code owner September 2, 2021 15:11
@google-cla google-cla bot added the cla: yes label Sep 2, 2021
@gsquared94 gsquared94 added docs-modifications runs the docs preview service on the given PR and removed cla: yes labels Sep 2, 2021
@google-cla google-cla bot added the cla: yes label Sep 2, 2021
@container-tools-bot
Copy link

Error creating deployment, please see controller logs for details.

@container-tools-bot container-tools-bot removed the docs-modifications runs the docs preview service on the given PR label Sep 2, 2021
@container-tools-bot
Copy link

Error creating deployment docs-controller-deployment-6559, please visit https://storage.googleapis.com/webhook-logs/logs-6559-1630595714060614606 to view logs.

@container-tools-bot
Copy link

Error creating deployment, please see controller logs for details.

@ahmetb
Copy link
Contributor

ahmetb commented Sep 2, 2021

@gsquared94 I would approach this cautiously.
I don't think search engines will click to that dropdown and wait for JS to execute, so any sub-page that is not directly linked from an <a href will no longer be indexed.

Is that desirable?

@gsquared94
Copy link
Contributor Author

@gsquared94 I would approach this cautiously.
I don't think search engines will click to that dropdown and wait for JS to execute, so any sub-page that is not directly linked from an <a href will no longer be indexed.

Is that desirable?

@ahmetb I can't say that I even considered this. I'm not too sure about what the benefits are of the different version pages being indexed.
I definitely want to change this to a dropdown menu but must admit that I'm not very good with frontend. Is there a better way for achieving this?

@gsquared94 gsquared94 added the docs-modifications runs the docs preview service on the given PR label Sep 2, 2021
@container-tools-bot
Copy link

Please visit http://34.94.142.103:1313 to view changes to the docs.

@container-tools-bot container-tools-bot removed the docs-modifications runs the docs preview service on the given PR label Sep 2, 2021
@ahmetb
Copy link
Contributor

ahmetb commented Sep 2, 2021

  1. I note that we already use some sort of JS loading this skaffod.yaml page itself as well as those different pages.

    For example, this cache does have no content of skaffold.yaml fields indexed (hence they cannot be used as search keywords).

    image

  2. But with this change, you'll also lose some results from https://www.google.com/search?q=%22skaffold.yaml%22+%22version+of+the+configuration%22 as these separate pages will not be recognized by the search bots and also since they are not in /sitemap.xml

    image

I'd say this is not making the situation worse, so go for it.

Copy link
Contributor

@aaron-prindle aaron-prindle left a comment

Choose a reason for hiding this comment

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

LGTM

@gsquared94 gsquared94 merged commit 70e9db9 into GoogleContainerTools:main Sep 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Multiple scrolls when displaying skaffold.yaml page using Chrome on Windows
4 participants