Skip to content

Commit a44dd2a

Browse files
committed
Add link to Java quickstart repo
Resolves smithy-lang#2523
1 parent bf865d3 commit a44dd2a

File tree

1 file changed

+16
-7
lines changed

1 file changed

+16
-7
lines changed

docs/source-2.0/java/quickstart.rst

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
Java Quickstart
33
===============
44

5-
This guide introduces `Smithy Java <https://github.com/smithy-lang/smithy-java>`_ with a simple working example of a generated server and client.
5+
This guide introduces `Smithy Java <https://github.com/smithy-lang/smithy-java>`_ with a simple working example of a
6+
generated server and client.
67

78
For this example, imagine that you are the proud owner of a coffee shop.
89
Your API allows your customers to order some *java* from their Java applications.
@@ -11,19 +12,24 @@ Users can use your SDK to list available coffees, order a coffee, and track the
1112
.. admonition:: Review
1213
:class: tip
1314

14-
If you are new to Smithy or just need a refresher on the basics, you may find it helpful to work through the Smithy :doc:`../quickstart`.
15+
If you are new to Smithy or just need a refresher on the basics, you may find it helpful to work through the
16+
Smithy :doc:`../quickstart`.
1517

1618
-------------
1719
Prerequisites
1820
-------------
1921

20-
* Ensure you have `JDK 17 <https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html>`_ or higher installed. Older Java versions are not supported by Smithy Java.
21-
* Ensure you have the the Smithy CLI installed. Run ``smithy --version`` to confirm the CLI is correctly installed. If you need to install the CLI, see :doc:`Smithy CLI Installation <../guides/smithy-cli/cli_installation>`.
22+
* Ensure you have `JDK 17 <https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html>`_ or higher
23+
installed. Older Java versions are not supported by Smithy Java.
24+
* Ensure you have the the Smithy CLI installed. Run ``smithy --version`` to confirm the CLI is correctly installed.
25+
If you need to install the CLI, see :doc:`Smithy CLI Installation <../guides/smithy-cli/cli_installation>`.
2226

2327
------
2428
Set Up
2529
------
26-
Clone the quickstart example template using the Smithy CLI ``init`` command and change to the cloned directory:
30+
31+
Clone the `quickstart example template <https://github.com/smithy-lang/smithy-examples/tree/main/smithy-java-examples/quickstart-java>`_
32+
using the Smithy CLI ``init`` command and change to the cloned directory:
2733

2834
.. code-block:: sh
2935
@@ -59,7 +65,8 @@ From the root of the example project, build the project using Gradle:
5965
Service Model
6066
-------------
6167

62-
The Smithy API model for our service can be found in the model package. This model defines the interface of our service and guides the generation of client and server code.
68+
The Smithy API model for our service can be found in the model package. This model defines the interface of our service and
69+
guides the generation of client and server code.
6370

6471
The service provides a few capabilities:
6572

@@ -80,7 +87,9 @@ The service has the ``@restJson1`` protocol trait applied indicating that the se
8087
...
8188
}
8289
83-
Protocols define the rules and conventions for serializing and de-serializing data when communicating between client and server.
90+
Protocols define the rules and conventions for serializing and de-serializing data when communicating between
91+
client and server.
92+
8493
Services can support multiple protocols at once.
8594

8695
-------------------

0 commit comments

Comments
 (0)