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 specific titles for each page #202

Merged
merged 1 commit into from
Dec 7, 2023
Merged

Add specific titles for each page #202

merged 1 commit into from
Dec 7, 2023

Conversation

gotmax23
Copy link
Contributor

@gotmax23 gotmax23 commented Dec 4, 2023

This makes it much easier to see what's going on with multiple tabs open.

For example:

Before:

Ansible Documentation

After:

Users | Ansible Documentation

New title

For example:

Before:

> Ansible Documentation

After:

> Users | Ansible Documentation
Copy link
Collaborator

@oraNod oraNod left a comment

Choose a reason for hiding this comment

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

Pretty neat @gotmax23 I like this but wonder if we should only set page_title related to the personas.

I'm not sure this should apply to pages related to the platform or automation controller. I can't see the use case of having that open in a tab alongside one of the persona pages. Plus some of the page titles are quite long:

title: Red Hat Ansible Automation Platform

Not to mention the fact that puts a RH product name on a community page. Not like that's a bad thing, but we're trying to achieve super clear separation of content. Over time those tower pages and the platform and archive pages will be phased out and we should consider them as being in "maintenance mode".

@@ -1,3 +1,4 @@
{% set page_title = pages.community.archive.title %}
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can do this in a follow up but this one is probably too long:

title: Join the Ansible community

I've been thinking about how we could improve it so it is more consistent with the other personas. It looks like an outlier in the navigation. Any thoughts?

@gotmax23
Copy link
Contributor Author

gotmax23 commented Dec 6, 2023

@oraNod, feel free to make suggestions or gh co the PR and push a change to remove the {% set page_title %} blocks you don't want.

As for the comment re. Red Hat pages, I'm not sure what's the issue here. The title for platform.html was previously just Ansible Documentation, and now it's Ansible Automation Platform | Ansible Documentation. Are you proposing changing it back to Ansible Documentation or something else?

@oraNod
Copy link
Collaborator

oraNod commented Dec 6, 2023

@gotmax23 Thanks. I don't mean to suggest that anything is an issue. I'm fine with pushing to your branch too if that suits you. That said I don't want to do that without a bit more explanation.

Eventually we'll sunset all the RH platform pages as that content is shifted to "redhat.com" and controller versions reach the end of the support lifecycle. The last supported controller version we're publishing to "docs.ansible.com" is 4.4 and that will EOL in ~2 years or so, at which time we'll be able to prune the entire "platform.html" page and other pages associated with the downstream offering. With that in mind perhaps it makes sense to not apply any updates to those templates (i.e. those pages are more or less considered deprecated and scheduled for removal).

On a similar note I would generally encourage anyone from the community to simply ignore the platform pages. As a member of the community you are perfectly entitled to modify the pages if you think that is the right thing to do. No problems. However the platform pages are intended for a different audience. It's great if you think they would benefit from the change and all contributions are welcome. At the same time the onus for maintaining and updating those pages does not fall on the community.

In regards to that different audience, RH has been working on shifting the content to "redhat.com", as I mentioned, to make sure that downstream content is not confused with community content. We want Red Hat customers to stop using "docs.ansible.com" as a destination for downstream content. The result of the page_title block in this PR would actually be Red Hat Ansible Automation Platform | Ansible Documentation and maybe leaving it as Ansible Documentation might help give the right signal, if that makes any sense.

Maybe I'm blowing things out of proportion. I don't know. It is a pretty trivial change at the end of the day. Please let me know what you think and I can push a commit for the platform pages. Like I said though I don't want to impose that and I'd like the reasoning to make sense. Cheers.

@samccann
Copy link
Collaborator

samccann commented Dec 6, 2023

Thanks @gotmax23 I think this is a great enhancement!

@oraNod - I'm not sure I see the problem with longer titles? Just looking at my browser tab for this Pr and it has a super long title, yet with a few tabs open, I can still distinguish it from other tabs.

As for not changing the platform page to match the rest, I'm inclined to disagree. While those pages might not be around forever, they will be for at least that two year EOL timeframe.

I did a quick check and the red hat page for AAP (the platform) doesn't have a conflicting title with this PR:
image

This image shows, in order - Red Hat AAP product page, The old platform page here, the new platform page based on this PR, and the Red Hat AAP product documentation page. They all look easily distinct to me.

What does come up to me is the little A icon is missing on the new page based on this PR. Any chance we can get that back? (or add it in a separate PR and turn it teal).

@gotmax23
Copy link
Contributor Author

gotmax23 commented Dec 6, 2023

Thanks everyone for the feedback!

I'm not sure I see the problem with longer titles? Just looking at my browser tab for this Pr and it has a super long title, yet with a few tabs open, I can still distinguish it from other tabs.

As for not changing the platform page to match the rest, I'm inclined to disagree. While those pages might not be around forever, they will be for at least that two year EOL timeframe.

I tend to agree.

What does come up to me is the little A icon is missing on the new page based on this PR. Any chance we can get that back?

This PR doesn't touch anything related to favicons. I assume that's due to how you're viewing the docs build.

@oraNod oraNod merged commit 46cfdba into ansible:main Dec 7, 2023
2 checks passed
@oraNod
Copy link
Collaborator

oraNod commented Dec 7, 2023

Thanks a mill for the docsite contribution @gotmax23

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.

3 participants