[DOCS-15569] Implementation of missing H1s for Docs Created: 24/Aug/22  Updated: 03/Apr/23  Resolved: 31/Mar/23

Status: Closed
Project: Documentation
Component/s: Realm
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Major - P3
Reporter: Eric Gamble Assignee: Chris Bush
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Participants:
Days since reply: 44 weeks, 2 days ago

 Description   

The urls for Docs are missing h1s. There are different languages for this section that were verified by mongodb native speakers of in that language which are : * Docs (EN)

Using the column labeled "H1 Recommendation (Final Decision)" in these sheets, could you all implement the H1s onto the these urls?
 



 Comments   
Comment by Josh Sciortino [ 03/Apr/23 ]

Thanks chris.bush@mongodb.com!

Comment by Chris Bush [ 31/Mar/23 ]

I've done what I can - the template of the javadoc generated reference docs can't be altered so, unless we want to reinvest in a project like Yokedox, we'll have to live without canonicals or h1s there. I added canonical links and updated the meta tags and titles where appropriate on the legacy pages, but didn't add h1s for fear of further breaking the layouts. I also redirected most of the pages anyway so this should be a moot point. I'm calling this done, any further requests of this nature should be handled by the platform team.

Comment by Chris Bush [ 29/Mar/23 ]

I have added canonical links to the 20 or so top pages. I noticed that some made no sense to have up at all and should be redirected completely, so I replaced the content with a redirect. For example, the jobs.html page for the old realm company now redirects to the mongodb careers page. I also updated the titles where appropriate to mention Legacy.
 

Comment by Elizabeth Baggan [ 03/Mar/23 ]

per our conversation in slack:

here’s the list of realm-legacy pages we should keep on /docs/ because they actually drive traffic (there are 28 of them) - the rest of the realm-legacy pages we are safe to move to an s3 bucket from my POV
so for the realm-legacy pages im recommending we keep on www (28 pages) - id like to update the canonicals (so since these are legacy pages, id recommend we make the canonical the most relevant current realm documentation page for each, and also update the meta data - so title tag, h1, and meta description to include “Realm Legacy” and then what the page is about)
im happy to get my team to come up with the meta data, but do you think you and your team could provide the canonicals? again it would be the most relevant, current realm documentation page so for
https://www.mongodb.com/docs/realm-legacy/docs/java/latest/index.html i believe we’d want the canonical to be
https://www.mongodb.com/docs/realm/sdk/java/ - this means that google would index the current realm doc over the legacy in time

Comment by Chris Bush [ 23/Feb/23 ]

I see, that sounds very doable. Do you have the sheet with which pages to keep on domain? I can make those changes.

Comment by Elizabeth Baggan [ 23/Feb/23 ]

Yes, that absolutely will solve the issues - since we are affectively going to be 404ing the mongodb.com pages they will be removed from Google's index and no longer count against us as Technical SEO debt.

But my concern then is that would result in a loss of traffic since the realm legacy docs do capture user demand and drive traffic. Hence my potential solution of moving the bottom 90% of realm legacy pages to the s3 bucket (ie removing them from mongodb.com) and manually updating the canonicals, h1s, etc. for the ~13 pages that bring in 90% of the traffic for that site section - so we 1. retain most of the traffic 2. get rid of the tech debt and 3. the effort of optimizing the pages that do bring in traffic is greatly reduced (canonicalizing the realm legacy pages that do bring in traffic to the current realm doc pages will also benefit the current realm doc pages so this is definitely something we would want to do as a fast follow).

Let me know if that makes sense to you

Comment by Chris Bush [ 23/Feb/23 ]

My question for you elizabeth.baggan@mongodb.com is whether moving to the bucket URL (off-domain) will satisfy the issues by effectively removing these pages from our analytics views? Or does that make no difference?

Comment by Elizabeth Baggan [ 23/Feb/23 ]

Ok - keep me posted on what Product says and we can figure out how to make the updates without harming organic traffic, optimizing where we can for search engines and ensuring the users are still getting what they need

Comment by Chris Bush [ 23/Feb/23 ]

Yes, updating these pages in any way is problematic, because we can't safely generate from the source anymore. That's why I'm asking if we can just move them to a bucket URL, so that they are technically "off domain" while still being available to those who really need them.

Comment by Elizabeth Baggan [ 23/Feb/23 ]

chris.bush@mongodb.com - thanks for the bump - gotcha - and if I remember correctly, adding canonical tags is difficult as well (is pretty much everything difficult about updating these pages??)

I'd say to go to Product and see what they say about removing them. What I might suggest is that we move over the bottom 90% of pages that are not bringing in traffic and the top 10% (~13 pages) we make some optimizations to like adding a canonical tag to the newer page version and updating the H1s of those page - maybe adding Legacy to the H1s are something too.

Let me know what you think - thanks!

Comment by Chris Bush [ 23/Feb/23 ]

elizabeth.baggan@mongodb.com any insight here? Meanwhile, working with product to sunset these docs

Comment by Josh Sciortino [ 21/Feb/23 ]

Hmm I might need to tag in elizabeth.baggan@mongodb.com on that to be sure.

Comment by Chris Bush [ 21/Feb/23 ]

Hi, would these problems with the legacy docs go away if we removed them from the mongodb domain? I can see if product would be ok with them just existing at an s3 bucket URL. (Updating the legacy pages is not straightforward)

Comment by Josh Sciortino [ 13/Jan/23 ]

Just following up on this to see if it can get assigned and a timeline. Thanks.
 

Comment by Josh Sciortino [ 01/Dec/22 ]

Just following up on this to see if it can get assigned and a timeline. Thanks.

Generated at Thu Feb 08 08:13:16 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.