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

Page titles should always include the product name #2978

Closed
josh-heyer opened this issue Jul 26, 2022 · 2 comments
Closed

Page titles should always include the product name #2978

josh-heyer opened this issue Jul 26, 2022 · 2 comments
Assignees
Labels
enhancement New feature or request

Comments

@josh-heyer
Copy link
Contributor

Summary

Right now, all page titles include a boilerplate "EDB Docs" prefix, but do not include the product name unless added manually by an author.

Problem

Examples:

  1. https://www.enterprisedb.com/docs/biganimal/latest/using_cluster/05_monitoring_and_logging/ - title is "EDB Docs - Monitoring and logging" (no mention of BigAnimal)
  2. https://www.enterprisedb.com/docs/biganimal/latest/using_cluster/05_monitoring_and_logging/monitoring_from_azure/ - title is "EDB Docs - Viewing metrics and logs from Azure" (no mention of BigAnimal)
  3. https://www.enterprisedb.com/docs/biganimal/latest/ - title is "EDB Docs - BigAnimal" (author included the product name)
  4. https://www.enterprisedb.com/docs/biganimal/latest/free_trial/ - title is "EDB Docs - Getting started with the BigAnimal free trial" (author included the product name)

In examples #1 and #2, it would benefit both searchers (who may not be able to easily identify the context of the result from the title + excerpt) and our SEO (increasing the ranking and specificity of product names / trademarks) to mechanically add the product name as a prefix, e.g. "EDB Docs - BigAnimal - Monitoring and logging"

In examples #3 and #4, the context is evident from the existing title.

Recommendation

Mechanically add the product name as a secondary prefix (after "EDB Docs") to titles that do not already contain the product name.

@josh-heyer josh-heyer added the enhancement New feature or request label Jul 26, 2022
@josh-heyer
Copy link
Contributor Author

After some discussion with @djw-m , we have the following idea:

  1. Trim EDB from the start of the product name
  2. Take title and prefix with EDB <product name> Docs -
  3. Don't worry about product name being integral to the title - repetition is fine

@gvasquezvargas
Copy link
Contributor

Outdated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants