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

Consolidate 3 demo pages — there should be only one #2158

Closed
4 tasks done
Tracked by #2163
chalin opened this issue Jan 12, 2023 · 7 comments
Closed
4 tasks done
Tracked by #2163

Consolidate 3 demo pages — there should be only one #2158

chalin opened this issue Jan 12, 2023 · 7 comments
Assignees
Labels

Comments

@chalin
Copy link
Contributor

chalin commented Jan 12, 2023

The fact that we have 3 demo pages with the same opening text is a bad smell, not great for SEO, potentially confusing for readers.

For context:

IMHO, it would be preferable to:

  • Have a single demo page
  • If we want the demo page more prominent, we can do so by adding menu entries that link to the canonical page.

Thoughts @svrnm @cartermp?


@chalin chalin added bug Something isn't working e0-minutes Effort: < 60 min p1-high analytics-and-seo labels Jan 12, 2023
@chalin chalin changed the title Consolidate 3 demo pages -- there should be only one Consolidate 3 demo pages — there should be only one Jan 12, 2023
@chalin
Copy link
Contributor Author

chalin commented Jan 12, 2023

If y'all agree, then which site path should be canonical?

@chalin
Copy link
Contributor Author

chalin commented Jan 12, 2023

I'd avoid adding it to the top level.

Have you considered the possibility of adding a link to the homepage, say, next to "Learn more"?

@chalin
Copy link
Contributor Author

chalin commented Jan 12, 2023

The repo demo title says that it's a "community" app, so the canonical link should be under community. I suggest dropping the top-level entry, and consider adding a link to the home page instead. My 2 cents.

@cartermp
Copy link
Contributor

For now I think the community page could be considered canonical, but it's not just a community app - it's a canonical reference implementation of opentelemetry. I think that elevates its importance tremendously, especially for an architect or someone in an IC leadership position at an organization who's tasked with understanding how OTel can fit into their systems more broadly. I would want to at least keep a menu entry under Getting Started for that purpose alone. Top-level is probably also fine I suppose, is there additional concern with having multiple menu entries?

@chalin
Copy link
Contributor Author

chalin commented Jan 16, 2023

For now I think the community page could be considered canonical

Ok

it's not just a community app - it's a canonical reference implementation of opentelemetry

Ok, that's important to know, and should be added to the page description and/or title.

I think that elevates its importance tremendously

Agreed.

I would want to at least keep a menu entry under Getting Started for that purpose alone

Ok.

Top-level is probably also fine I suppose,

I'd avoid adding it to the Docs top level. Instead, I'd propose adding a link to the demo to either:

  • The homepage
  • The top nav

I'd vote for the former. Thoughts?

is there additional concern with having multiple menu entries?

No.

@chalin
Copy link
Contributor Author

chalin commented Jan 16, 2023

FYI, I'm going to address the changes to this issue incrementally. First, I'll eliminate the page duplication, then I can address adding mention of the demo being a "reference implementation", etc.

@chalin
Copy link
Contributor Author

chalin commented Feb 3, 2023

Closed by #2257

@chalin chalin closed this as completed Feb 3, 2023
@chalin chalin mentioned this issue Feb 3, 2023
27 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants