[DOCS-15407] [Drivers] Add "Kotlin" and "Typescript" to drivers main page Created: 11/Jun/22  Updated: 29/Oct/23  Resolved: 14/Apr/23

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

Type: Improvement Priority: Critical - P2
Reporter: Rachelle Palmer Assignee: Christopher Cho
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Attachments: Zip Archive icons.zip    
Issue Links:
Depends
Duplicate
Related
is related to DRIVERS-1371 Kotlin Driver Closed
Participants:
Days since reply: 42 weeks, 6 days ago
Story Points: 1

 Description   

Summary of Requested Change

https://www.mongodb.com/docs/drivers/
is incomplete. Users can also utilize Kotlin and Typescript with their MongoDB applications. We need to add icons for both these languages, and then add new landing pages/URLs underneath. For Kotlin, we would add a page saying that it is easy to use the kmongo community driver or to use the native Java driver. For typescript, we need to inform users that they would use the "NODE" driver (which is actually now written in typescript anyway).

cc jeff.yemin@mtvstaff.com and neal.beeken@mongodb.com

Motivation

We have users asking about how to use Kotlin and Typescript for their mongodb applications, and it is not clear from our documentation that is not only possible, but easy to do this.

Requires investigation and discussion.



 Comments   
Comment by Githook User [ 13/Apr/23 ]

Author:

{'name': 'Chris Cho', 'email': 'chris.cho@mongodb.com', 'username': 'ccho-mongodb'}

Message: DOCS-15407 new icons (#871)

Comment by Christopher Cho [ 13/Apr/23 ]

https://github.com/mongodb/docs-ecosystem/pull/871

Comment by Annie Surman [ 13/Apr/23 ]

jonathan.destefano@mongodb.com chris.cho@mongodb.com – We've been discussing this with rachelle.palmer@mongodb.com. Given the non-ideal experience of Platform deploying the changes last week, we think it's best for the Content team, with more expertise in the toolchain, should own the implementation of these changes.

I'll defer to the two of you as to when this is best done, but rachelle.palmer@mongodb.com will need to see this live by .local NYC, ideally before then.

Comment by Cassidy Schaufele [ 10/Apr/23 ]

I've since attached icons used in staging link at https://docs-mongodbcom-integration.corp.mongodb.com/5bb2e3da94e6e3f79fab7b5be9c1928b474786ea/feature/DOP-3375/drivers/caesarbell/feature/DOP-3375/ as a point of reference.

See https://mongodb.slack.com/archives/C018UTGP23T/p1681158293859379 for full details.

Original commit at https://github.com/mongodb/docs-ecosystem/commit/17415e612746d18ecf8cfb3e0c0a6dffa99cc2ac will be safe to use if assets are added alongside - assets were present in staged links but not added in the commit, and thus not present in production.

Comment by Rachelle Palmer [ 23/Mar/23 ]

huzzah thank you! cc iz.nettere@mongodb.com

Comment by Dylan Birtolo (Inactive) [ 22/Mar/23 ]

rachelle.palmer@mongodb.com - The TypeScript landing page has been created and can be seen here: https://www.mongodb.com/docs/drivers/typescript/

The Kotlin one doesn't exist yet, but we do have a page you could link to if there's a TypeScript icon.

Comment by Cassidy Schaufele [ 23/Nov/22 ]

There'll need to be a design asset in Figma for our future use in any mockups regardless, so it needs to flow through Allison Mui or enfervsciel@gmail.com to make sure they're kept in the loop for the assets that we go with

Comment by Rachelle Palmer [ 23/Nov/22 ]

cassidy.schaufele@mongodb.comI think we might already have these in Flora because of the work done on DevCenter (they are located here https://www.mongodb.com/developer/languages/ , I would probably ask Mike Waltzer?

Comment by Cassidy Schaufele [ 22/Nov/22 ]

chris.cho@mongodb.com and rachelle.palmer@mongodb.com 

DOP can add the tiles w/ icons as needed.

We'll need icons as SVG assets, since icons for Kotlin or Typescript currently don't exist in our repository. allison.mui@mongodb.com, is this something you could help with?

We'll also need final confirmation of any copy (I'd assume the tiles should say Kotlin and Typscript respectively. We don't control any of the other copy on the page, so that will have to be a separate change).

Lastly, we'll need to know where the new tiles should link to - and if there needs to be a new page/property they link to, then we'll need that to exist first before adding the tiles. 

I'm creating a ticket now and will link it in this comment via edit.
Edit: ticket to track DOP's portion of work is at https://jira.mongodb.org/browse/DOP-3375
We'll need final confirmation of the destinations and svg assets before the ticket can be engineering ready.

Comment by Christopher Cho [ 22/Nov/22 ]

Would it be possible for Docs Platform Team to help make minor updates to the Drivers Landing Page to add some information to direct readers looking for information on how to use MongoDB with Typescript and Kotlin independent of the IA initiative for now, and then change it to the revision that comes out of the IA initiative when that's completed?

As described in the ticket summary, we could add two items with icons and maybe the intro text could be updated to read "drivers" or "driver libraries" instead of "libraries" for now.

Comment by Rachelle Palmer [ 22/Nov/22 ]

I spoke witth jonathan.destefano@mongodb.com about this – this page will require the Docs Platform team to make the change, the docs writers aren't responsible for it. Probably the ticket therefore needs to be moved.

Comment by Annie Surman [ 22/Nov/22 ]

Hey all, following up on this. The IA Initiative isn't lead by the platform team – the engineering team will be contributing to implementation, but isn't directly involved right now. I'm afraid I can't provide much more insight as to why this item might be dependent on IA. Shot in the dark, perhaps shayla.hill@mongodb.com or allison.mui@mongodb.com has more context? Sorry I can't be of more help!

Comment by Rachelle Palmer [ 03/Nov/22 ]

Our Node Driver was re-written in typescript more than a year ago; we are starting a Kotlin driver now........ what does that have to do with the docs IA project at all?

Comment by Christopher Cho [ 31/Oct/22 ]

I was told that I should wait for the outcome of the related design project as mentioned. Referring you to annie.surman@mongodb.com as this is project is not related to my team.

Comment by Rachelle Palmer [ 31/Oct/22 ]

Can we have an update? Specifically:

  • why would it take 6+ months to add Kotlin and Typescript icons to the page?
  • why would it need a design project to add those icons for languages we already support?

please be specific

Comment by Christopher Cho [ 27/Sep/22 ]

Waiting for outcome of a related design project scheduled this quarter. From what I recall, "Data Platform IA" (https://jira.mongodb.org/browse/INIT-306) is related to the design project

Comment by Rachelle Palmer [ 23/Jun/22 ]

I would love to use either (languages or libraries) – please see https://www.mongodb.com/developer/languages/ as a model

We have ample customer research showing that most of our users don't know what a 'driver' is and instead refer to it as a library or an SDK

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