DOCSP-41115: get started #7
Conversation
👷 Deploy request for docs-kotlin-sync pending review.Visit the deploys page to approve it
|
| .. step:: Install {+language+} | ||
|
|
||
| Make sure that your system has {+language+} installed and running | ||
| on JDK 1.8 or later. For more information on getting started with | ||
| {+language+} and JVM development, see `Get started with Kotlin/JVM | ||
| <{+kotlin-docs+}/docs/jvm-get-started.html>`__ in the {+language+} | ||
| language documentation. | ||
|
|
||
| .. step:: Create a {+language+} Project | ||
|
|
||
| This guide shows you how to add the {+driver-short+} dependencies | ||
| by using Gradle or Maven. We recommend that you use an integrated development | ||
| environment (IDE) such as IntelliJ IDEA or Eclipse IDE to configure | ||
| Gradle or Maven to build and run your project. |
There was a problem hiding this comment.
The instructions in step 1 dictate using IntelliJ to create a Kotlin project, so a reader who gets to step 2: Create a Project might have already created the project.
Suggestion would be maybe to reconfigure this to be installing the IDE in step 1 and linking to the Kotlin docs to create the project in step 2? Happy to discuss further.
There was a problem hiding this comment.
How about we get rid of step 1 and move that information into step 2?
| .. note:: | ||
|
|
||
| This example uses a {+language+} data class to model MongoDB data. |
There was a problem hiding this comment.
I'm seeing that we have a task to add a Specialized Data Formats > Data Classes page, could be a good idea to leave a TODO here to link to that page for more info once it's built.
There was a problem hiding this comment.
Theres a tip commented out at the bottom that will link to that page. Right now, I cant figure out how to comment things out in the body of a step
| If you don't see any output or receive an error, check whether you | ||
| included the proper connection string in your application. Also, confirm | ||
| that you successfully loaded the sample dataset into your MongoDB Atlas cluster. | ||
|
|
||
| After completing this step, you have a working application that uses | ||
| the {+driver-short+} to connect to your MongoDB cluster, run a query on the | ||
| sample data, and print out the result. |
There was a problem hiding this comment.
Indentation here is breaking formatting
|
|
||
| .. procedure:: | ||
| :style: connected | ||
|
|
||
| .. step:: Create a {+language+} Project | ||
|
|
||
| First, make sure that your system has {+language+} installed and | ||
| running on JDK 1.8 or later. | ||
|
|
||
| This guide shows you how to create a project and add the | ||
| {+driver-short+} dependencies by using Gradle or Maven. We | ||
| recommend that you use an integrated development | ||
| environment (IDE) such as IntelliJ IDEA or Eclipse IDE to | ||
| configure Gradle or Maven to build and run your project. |
There was a problem hiding this comment.
I'd still lead with the "This guide..." sentence, maybe pull it up to the top level before the steps:
| .. procedure:: | |
| :style: connected | |
| .. step:: Create a {+language+} Project | |
| First, make sure that your system has {+language+} installed and | |
| running on JDK 1.8 or later. | |
| This guide shows you how to create a project and add the | |
| {+driver-short+} dependencies by using Gradle or Maven. We | |
| recommend that you use an integrated development | |
| environment (IDE) such as IntelliJ IDEA or Eclipse IDE to | |
| configure Gradle or Maven to build and run your project. | |
| This guide shows you how to create a project and add the | |
| {+driver-short+} dependencies by using Gradle or Maven. | |
| .. procedure:: | |
| :style: connected | |
| .. step:: Create a {+language+} Project | |
| First, make sure that your system has {+language+} installed and | |
| running on JDK 1.8 or later. | |
| We recommend that you use an integrated development | |
| environment (IDE) such as IntelliJ IDEA or Eclipse IDE to | |
| configure Gradle or Maven to build and run your project. |
rustagir
requested review from
a team and
stIncMale
and removed request for
a team
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-41115
Staging - https://preview-mongodbrustagir.gatsbyjs.io/kotlin-sync/DOCSP-41115-get-started/get-started/
Self-Review Checklist