diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6f0b1ab21bc..427c3962858 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,7 +11,7 @@ information to effectively respond to your bug report or contribution. We welcome you to use the GitHub issue tracker to report bugs or suggest features. -When filing an issue, please check [existing open](https://github.com/awslabs/smithy/issues), or [recently closed](https://github.com/awslabs/smithy/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already +When filing an issue, please check [existing open](https://github.com/smithy-lang/smithy/issues), or [recently closed](https://github.com/smithy-lang/smithy/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already reported the issue. Please try to include as much information as you can. Details like these are incredibly useful: * A reproducible test case or series of steps @@ -48,7 +48,7 @@ and [creating a pull request](https://help.github.com/articles/creating-a-pull-r ## Finding contributions to work on -Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](https://github.com/awslabs/smithy/labels/help%20wanted) issues is a great place to start. +Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](https://github.com/smithy-lang/smithy/labels/help%20wanted) issues is a great place to start. ## Testing with AWS SDK code generators @@ -77,4 +77,4 @@ If you discover a potential security issue in this project we ask that you notif ## Licensing -See the [LICENSE](https://github.com/awslabs/smithy/blob/main/LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution. +See the [LICENSE](https://github.com/smithy-lang/smithy/blob/main/LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution. diff --git a/README.md b/README.md index 38d095bc51c..637d3ea99d5 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # Smithy Smithy -[![Build Status](https://github.com/awslabs/smithy/workflows/ci/badge.svg)](https://github.com/awslabs/smithy/actions/workflows/ci.yml) +[![Build Status](https://github.com/smithy-lang/smithy/workflows/ci/badge.svg)](https://github.com/smithy-lang/smithy/actions/workflows/ci.yml) Smithy defines and generates clients, services, and documentation for any protocol. diff --git a/build.gradle b/build.gradle index 3d55a5dbdf3..7c2f8d87e53 100644 --- a/build.gradle +++ b/build.gradle @@ -154,7 +154,7 @@ subprojects { pom { name.set(project.ext["displayName"].toString()) description.set(project.description) - url.set("https://github.com/awslabs/smithy") + url.set("https://github.com/smithy-lang/smithy") licenses { license { name.set("Apache License 2.0") @@ -172,7 +172,7 @@ subprojects { } } scm { - url.set("https://github.com/awslabs/smithy.git") + url.set("https://github.com/smithy-lang/smithy.git") } } } diff --git a/docs/source-1.0/guides/evolving-models.rst b/docs/source-1.0/guides/evolving-models.rst index 6b1f875a8e0..99066c33927 100644 --- a/docs/source-1.0/guides/evolving-models.rst +++ b/docs/source-1.0/guides/evolving-models.rst @@ -129,6 +129,6 @@ The following changes to trait definitions are backward compatible: Using Smithy Diff ================= -`Smithy Diff `_ is a +`Smithy Diff `_ is a tool used to compare two Smithy models to check for backward compatibility issues. Smithy Diff can be run via a Java library or via the Smithy CLI. diff --git a/docs/source-1.0/index.rst b/docs/source-1.0/index.rst index 47eef43cef0..e4f24a6239f 100644 --- a/docs/source-1.0/index.rst +++ b/docs/source-1.0/index.rst @@ -30,5 +30,5 @@ Read more .. toctree:: :caption: Project links - Source code + Source code 2.0 Documentation diff --git a/docs/source-1.0/spec/aws/aws-ec2-query-protocol.rst b/docs/source-1.0/spec/aws/aws-ec2-query-protocol.rst index 2ed6362ccda..d15859283ec 100644 --- a/docs/source-1.0/spec/aws/aws-ec2-query-protocol.rst +++ b/docs/source-1.0/spec/aws/aws-ec2-query-protocol.rst @@ -392,7 +392,7 @@ Protocol compliance tests ------------------------- A full compliance test suite is provided and SHALL be considered a normative -reference: https://github.com/awslabs/smithy/tree/main/smithy-aws-protocol-tests/model/ec2Query +reference: https://github.com/smithy-lang/smithy/tree/main/smithy-aws-protocol-tests/model/ec2Query These compliance tests define a model that is used to define test cases and the expected serialized HTTP requests and responses for each case. diff --git a/docs/source-1.0/spec/aws/aws-json-1_0-protocol.rst b/docs/source-1.0/spec/aws/aws-json-1_0-protocol.rst index c4f48c29130..30aebc72a74 100644 --- a/docs/source-1.0/spec/aws/aws-json-1_0-protocol.rst +++ b/docs/source-1.0/spec/aws/aws-json-1_0-protocol.rst @@ -22,7 +22,7 @@ Trait selector Value type Structure See - `Protocol tests `_ + `Protocol tests `_ ``aws.protocols#awsJson1_0`` is a structure that supports the following members: @@ -134,7 +134,7 @@ The following example defines a service that requires the use of .. |quoted shape name| replace:: ``awsJson1_0`` .. |protocol content type| replace:: ``application/x-amz-json-1.0`` .. |protocol error type contents| replace:: :ref:`shape-id` -.. |protocol test link| replace:: https://github.com/awslabs/smithy/tree/main/smithy-aws-protocol-tests/model/awsJson1_0 +.. |protocol test link| replace:: https://github.com/smithy-lang/smithy/tree/main/smithy-aws-protocol-tests/model/awsJson1_0 .. include:: aws-json.rst.template .. include:: error-rename-simple.rst.template diff --git a/docs/source-1.0/spec/aws/aws-json-1_1-protocol.rst b/docs/source-1.0/spec/aws/aws-json-1_1-protocol.rst index 0d61d9174da..b07379944eb 100644 --- a/docs/source-1.0/spec/aws/aws-json-1_1-protocol.rst +++ b/docs/source-1.0/spec/aws/aws-json-1_1-protocol.rst @@ -22,7 +22,7 @@ Trait selector Value type Structure See - `Protocol tests `_ + `Protocol tests `_ ``aws.protocols#awsJson1_1`` is a structure that supports the following members: @@ -134,7 +134,7 @@ The following example defines a service that requires the use of .. |quoted shape name| replace:: ``awsJson1_1`` .. |protocol content type| replace:: ``application/x-amz-json-1.1`` .. |protocol error type contents| replace:: :token:`shape name ` -.. |protocol test link| replace:: https://github.com/awslabs/smithy/tree/main/smithy-aws-protocol-tests/model/awsJson1_1 +.. |protocol test link| replace:: https://github.com/smithy-lang/smithy/tree/main/smithy-aws-protocol-tests/model/awsJson1_1 .. include:: aws-json.rst.template .. include:: error-rename.rst.template diff --git a/docs/source-1.0/spec/aws/aws-query-protocol.rst b/docs/source-1.0/spec/aws/aws-query-protocol.rst index b9e1ad49c68..384559ce93f 100644 --- a/docs/source-1.0/spec/aws/aws-query-protocol.rst +++ b/docs/source-1.0/spec/aws/aws-query-protocol.rst @@ -459,7 +459,7 @@ Trait selector Value type Annotation trait. See - `Protocol tests `_ + `Protocol tests `_ .. tabs:: @@ -634,7 +634,7 @@ Protocol compliance tests ------------------------- A full compliance test suite is provided and SHALL be considered a normative -reference: https://github.com/awslabs/smithy/tree/main/smithy-aws-protocol-tests/model/awsQuery +reference: https://github.com/smithy-lang/smithy/tree/main/smithy-aws-protocol-tests/model/awsQuery These compliance tests define a model that is used to define test cases and the expected serialized HTTP requests and responses for each case. diff --git a/docs/source-1.0/spec/aws/aws-restjson1-protocol.rst b/docs/source-1.0/spec/aws/aws-restjson1-protocol.rst index c58dbecafd4..eb65d62de25 100644 --- a/docs/source-1.0/spec/aws/aws-restjson1-protocol.rst +++ b/docs/source-1.0/spec/aws/aws-restjson1-protocol.rst @@ -347,7 +347,7 @@ Protocol compliance tests ------------------------- A full compliance test suite is provided and SHALL be considered a normative -reference: https://github.com/awslabs/smithy/tree/main/smithy-aws-protocol-tests/model/restJson1 +reference: https://github.com/smithy-lang/smithy/tree/main/smithy-aws-protocol-tests/model/restJson1 These compliance tests define a model that is used to define test cases and the expected serialized HTTP requests and responses for each case. diff --git a/docs/source-1.0/spec/aws/aws-restxml-protocol.rst b/docs/source-1.0/spec/aws/aws-restxml-protocol.rst index 672f53875b8..ab971cad307 100644 --- a/docs/source-1.0/spec/aws/aws-restxml-protocol.rst +++ b/docs/source-1.0/spec/aws/aws-restxml-protocol.rst @@ -311,7 +311,7 @@ Protocol compliance tests ------------------------- A full compliance test suite is provided and SHALL be considered a normative -reference: https://github.com/awslabs/smithy/tree/main/smithy-aws-protocol-tests/model/restXml +reference: https://github.com/smithy-lang/smithy/tree/main/smithy-aws-protocol-tests/model/restXml These compliance tests define a model that is used to define test cases and the expected serialized HTTP requests and responses for each case. diff --git a/docs/source-1.0/spec/core/index.rst b/docs/source-1.0/spec/core/index.rst index 2aec8f97ee1..551bf10add8 100644 --- a/docs/source-1.0/spec/core/index.rst +++ b/docs/source-1.0/spec/core/index.rst @@ -20,7 +20,7 @@ This specification makes use of the Augmented Backus-Naur Form (ABNF) of that document. Readers are invited to report technical errors and ambiguities in this -specification to the Smithy GitHub repository at https://github.com/awslabs/smithy. +specification to the Smithy GitHub repository at https://github.com/smithy-lang/smithy. This specification is open source, so contributions are welcome. .. rubric:: Examples diff --git a/docs/source-1.0/spec/core/selectors.rst b/docs/source-1.0/spec/core/selectors.rst index 0b8613b9bf0..ab5fd940c79 100644 --- a/docs/source-1.0/spec/core/selectors.rst +++ b/docs/source-1.0/spec/core/selectors.rst @@ -1713,7 +1713,7 @@ Below is an example selector compliance test: string AtLeastTen The compliance tests can also be accessed in this -`directory `__ +`directory `__ of the Smithy Github repository. .. _ABNF: https://tools.ietf.org/html/rfc5234 diff --git a/docs/source-2.0/aws/protocols/aws-ec2-query-protocol.rst b/docs/source-2.0/aws/protocols/aws-ec2-query-protocol.rst index c4d3d0b5a6d..ceca5c388ca 100644 --- a/docs/source-2.0/aws/protocols/aws-ec2-query-protocol.rst +++ b/docs/source-2.0/aws/protocols/aws-ec2-query-protocol.rst @@ -358,7 +358,7 @@ Protocol compliance tests ------------------------- A full compliance test suite is provided and SHALL be considered a normative -reference: https://github.com/awslabs/smithy/tree/main/smithy-aws-protocol-tests/model/ec2Query +reference: https://github.com/smithy-lang/smithy/tree/main/smithy-aws-protocol-tests/model/ec2Query These compliance tests define a model that is used to define test cases and the expected serialized HTTP requests and responses for each case. diff --git a/docs/source-2.0/aws/protocols/aws-json-1_0-protocol.rst b/docs/source-2.0/aws/protocols/aws-json-1_0-protocol.rst index 79ea6319cd7..081c6ab261d 100644 --- a/docs/source-2.0/aws/protocols/aws-json-1_0-protocol.rst +++ b/docs/source-2.0/aws/protocols/aws-json-1_0-protocol.rst @@ -22,7 +22,7 @@ Trait selector Value type Structure See - `Protocol tests `_ + `Protocol tests `_ ``aws.protocols#awsJson1_0`` is a structure that supports the following members: @@ -125,7 +125,7 @@ The following example defines a service that requires the use of .. |quoted shape name| replace:: ``awsJson1_0`` .. |protocol content type| replace:: ``application/x-amz-json-1.0`` .. |protocol error type contents| replace:: :ref:`shape-id` -.. |protocol test link| replace:: https://github.com/awslabs/smithy/tree/main/smithy-aws-protocol-tests/model/awsJson1_0 +.. |protocol test link| replace:: https://github.com/smithy-lang/smithy/tree/main/smithy-aws-protocol-tests/model/awsJson1_0 .. include:: aws-json.rst.template .. include:: error-rename-simple.rst.template diff --git a/docs/source-2.0/aws/protocols/aws-json-1_1-protocol.rst b/docs/source-2.0/aws/protocols/aws-json-1_1-protocol.rst index 022056a1b3e..04e657db1d3 100644 --- a/docs/source-2.0/aws/protocols/aws-json-1_1-protocol.rst +++ b/docs/source-2.0/aws/protocols/aws-json-1_1-protocol.rst @@ -22,7 +22,7 @@ Trait selector Value type Structure See - `Protocol tests `_ + `Protocol tests `_ ``aws.protocols#awsJson1_1`` is a structure that supports the following members: @@ -125,7 +125,7 @@ The following example defines a service that requires the use of .. |quoted shape name| replace:: ``awsJson1_1`` .. |protocol content type| replace:: ``application/x-amz-json-1.1`` .. |protocol error type contents| replace:: :token:`shape name ` -.. |protocol test link| replace:: https://github.com/awslabs/smithy/tree/main/smithy-aws-protocol-tests/model/awsJson1_1 +.. |protocol test link| replace:: https://github.com/smithy-lang/smithy/tree/main/smithy-aws-protocol-tests/model/awsJson1_1 .. include:: aws-json.rst.template .. include:: error-rename.rst.template diff --git a/docs/source-2.0/aws/protocols/aws-query-protocol.rst b/docs/source-2.0/aws/protocols/aws-query-protocol.rst index 8d22a28a402..2ccc4574ce3 100644 --- a/docs/source-2.0/aws/protocols/aws-query-protocol.rst +++ b/docs/source-2.0/aws/protocols/aws-query-protocol.rst @@ -459,7 +459,7 @@ Trait selector Value type Annotation trait. See - `Protocol tests `_ + `Protocol tests `_ .. code-block:: smithy @@ -595,7 +595,7 @@ Protocol compliance tests ------------------------- A full compliance test suite is provided and SHALL be considered a normative -reference: https://github.com/awslabs/smithy/tree/main/smithy-aws-protocol-tests/model/awsQuery +reference: https://github.com/smithy-lang/smithy/tree/main/smithy-aws-protocol-tests/model/awsQuery These compliance tests define a model that is used to define test cases and the expected serialized HTTP requests and responses for each case. diff --git a/docs/source-2.0/aws/protocols/aws-restjson1-protocol.rst b/docs/source-2.0/aws/protocols/aws-restjson1-protocol.rst index dc2367d2fe7..a383077c133 100644 --- a/docs/source-2.0/aws/protocols/aws-restjson1-protocol.rst +++ b/docs/source-2.0/aws/protocols/aws-restjson1-protocol.rst @@ -343,7 +343,7 @@ Protocol compliance tests ------------------------- A full compliance test suite is provided and SHALL be considered a normative -reference: https://github.com/awslabs/smithy/tree/main/smithy-aws-protocol-tests/model/restJson1 +reference: https://github.com/smithy-lang/smithy/tree/main/smithy-aws-protocol-tests/model/restJson1 These compliance tests define a model that is used to define test cases and the expected serialized HTTP requests and responses for each case. diff --git a/docs/source-2.0/aws/protocols/aws-restxml-protocol.rst b/docs/source-2.0/aws/protocols/aws-restxml-protocol.rst index cc2c39cedbd..cb32bee0a40 100644 --- a/docs/source-2.0/aws/protocols/aws-restxml-protocol.rst +++ b/docs/source-2.0/aws/protocols/aws-restxml-protocol.rst @@ -309,7 +309,7 @@ Protocol compliance tests ------------------------- A full compliance test suite is provided and SHALL be considered a normative -reference: https://github.com/awslabs/smithy/tree/main/smithy-aws-protocol-tests/model/restXml +reference: https://github.com/smithy-lang/smithy/tree/main/smithy-aws-protocol-tests/model/restXml These compliance tests define a model that is used to define test cases and the expected serialized HTTP requests and responses for each case. diff --git a/docs/source-2.0/guides/building-codegen/creating-codegen-repo.rst b/docs/source-2.0/guides/building-codegen/creating-codegen-repo.rst index 3301c14faac..1f600163c8a 100644 --- a/docs/source-2.0/guides/building-codegen/creating-codegen-repo.rst +++ b/docs/source-2.0/guides/building-codegen/creating-codegen-repo.rst @@ -210,7 +210,7 @@ remote repository. You can add packages to Maven local using Gradle: ./gradlew :smithy-mylang-codegen:pTML If you need to use unreleased changes to -`awslabs/smithy `__, then clone the +`awslabs/smithy `__, then clone the repository and run: .. code-block:: none diff --git a/docs/source-2.0/guides/building-codegen/decoupling-codegen-with-symbols.rst b/docs/source-2.0/guides/building-codegen/decoupling-codegen-with-symbols.rst index 143f7f435ff..595f350650c 100644 --- a/docs/source-2.0/guides/building-codegen/decoupling-codegen-with-symbols.rst +++ b/docs/source-2.0/guides/building-codegen/decoupling-codegen-with-symbols.rst @@ -16,7 +16,7 @@ Quick Symbol example ==================== The following example uses the built-in "``T``" formatter of -`SymbolWriter `_ +`SymbolWriter `_ to write symbols to the generated code and automatically add imports to the file: @@ -173,7 +173,7 @@ can be written to whatever dependency manifest format is needed for the target environment. Dependencies are registered with a Symbol by creating a -`SymbolDependency `_ +`SymbolDependency `_ and adding them to the Symbol via ``Symbol#addDependency``. The following example creates a TypeScript Symbol for big decimal that @@ -750,11 +750,11 @@ used to convert each nested namespace's imports to a string. It's an abstract exercise left up to the implementation. -.. _SymbolReference: https://github.com/awslabs/smithy/blob/main/smithy-codegen-core/src/main/java/software/amazon/smithy/codegen/core/SymbolReference.java -.. _SymbolDependencyContainer: https://github.com/awslabs/smithy/blob/main/smithy-codegen-core/src/main/java/software/amazon/smithy/codegen/core/SymbolDependencyContainer.java -.. _DependencyTracker: https://github.com/awslabs/smithy/blob/main/smithy-codegen-core/src/main/java/software/amazon/smithy/codegen/core/DependencyTracker.java -.. _ReservedWords: https://github.com/awslabs/smithy/blob/main/smithy-codegen-core/src/main/java/software/amazon/smithy/codegen/core/ReservedWords.java -.. _ReservedWordsBuilder: https://github.com/awslabs/smithy/blob/main/smithy-codegen-core/src/main/java/software/amazon/smithy/codegen/core/ReservedWordsBuilder.java -.. _ImportContainer: https://github.com/awslabs/smithy/blob/main/smithy-codegen-core/src/main/java/software/amazon/smithy/codegen/core/ImportContainer.java -.. _SymbolWriter: https://github.com/awslabs/smithy/blob/main/smithy-codegen-core/src/main/java/software/amazon/smithy/codegen/core/SymbolWriter.java -.. _WriterDelegator: https://github.com/awslabs/smithy/blob/main/smithy-codegen-core/src/main/java/software/amazon/smithy/codegen/core/WriterDelegator.java +.. _SymbolReference: https://github.com/smithy-lang/smithy/blob/main/smithy-codegen-core/src/main/java/software/amazon/smithy/codegen/core/SymbolReference.java +.. _SymbolDependencyContainer: https://github.com/smithy-lang/smithy/blob/main/smithy-codegen-core/src/main/java/software/amazon/smithy/codegen/core/SymbolDependencyContainer.java +.. _DependencyTracker: https://github.com/smithy-lang/smithy/blob/main/smithy-codegen-core/src/main/java/software/amazon/smithy/codegen/core/DependencyTracker.java +.. _ReservedWords: https://github.com/smithy-lang/smithy/blob/main/smithy-codegen-core/src/main/java/software/amazon/smithy/codegen/core/ReservedWords.java +.. _ReservedWordsBuilder: https://github.com/smithy-lang/smithy/blob/main/smithy-codegen-core/src/main/java/software/amazon/smithy/codegen/core/ReservedWordsBuilder.java +.. _ImportContainer: https://github.com/smithy-lang/smithy/blob/main/smithy-codegen-core/src/main/java/software/amazon/smithy/codegen/core/ImportContainer.java +.. _SymbolWriter: https://github.com/smithy-lang/smithy/blob/main/smithy-codegen-core/src/main/java/software/amazon/smithy/codegen/core/SymbolWriter.java +.. _WriterDelegator: https://github.com/smithy-lang/smithy/blob/main/smithy-codegen-core/src/main/java/software/amazon/smithy/codegen/core/WriterDelegator.java diff --git a/docs/source-2.0/guides/building-codegen/generating-code.rst b/docs/source-2.0/guides/building-codegen/generating-code.rst index 80e09e06d61..460011b4d59 100644 --- a/docs/source-2.0/guides/building-codegen/generating-code.rst +++ b/docs/source-2.0/guides/building-codegen/generating-code.rst @@ -672,7 +672,7 @@ Leading whitespace cannot be removed when using // ^ ^ invalid combination -.. _AbstractCodeWriter: https://github.com/awslabs/smithy/blob/main/smithy-utils/src/main/java/software/amazon/smithy/utils/AbstractCodeWriter.java -.. _SimpleCodeWriter: https://github.com/awslabs/smithy/blob/main/smithy-utils/src/main/java/software/amazon/smithy/utils/SimpleCodeWriter.java -.. _SymbolWriter: https://github.com/awslabs/smithy/blob/main/smithy-codegen-core/src/main/java/software/amazon/smithy/codegen/core/SymbolWriter.java +.. _AbstractCodeWriter: https://github.com/smithy-lang/smithy/blob/main/smithy-utils/src/main/java/software/amazon/smithy/utils/AbstractCodeWriter.java +.. _SimpleCodeWriter: https://github.com/smithy-lang/smithy/blob/main/smithy-utils/src/main/java/software/amazon/smithy/utils/SimpleCodeWriter.java +.. _SymbolWriter: https://github.com/smithy-lang/smithy/blob/main/smithy-codegen-core/src/main/java/software/amazon/smithy/codegen/core/SymbolWriter.java .. _Java text blocks: https://docs.oracle.com/en/java/javase/13/text_blocks/index.html diff --git a/docs/source-2.0/guides/building-codegen/implementing-the-generator.rst b/docs/source-2.0/guides/building-codegen/implementing-the-generator.rst index ad211b6b220..33906560d61 100644 --- a/docs/source-2.0/guides/building-codegen/implementing-the-generator.rst +++ b/docs/source-2.0/guides/building-codegen/implementing-the-generator.rst @@ -3,7 +3,7 @@ Implementing the Generator -------------------------- This document describes how to implement a code generator using the -high-level `DirectedCodegen `__ +high-level `DirectedCodegen `__ interface. @@ -219,4 +219,4 @@ Tips for using ``DirectedCodegen`` data you need. -.. _source code for DirectedCodegen: https://github.com/awslabs/smithy/blob/main/smithy-codegen-core/src/main/java/software/amazon/smithy/codegen/core/directed/DirectedCodegen.java +.. _source code for DirectedCodegen: https://github.com/smithy-lang/smithy/blob/main/smithy-codegen-core/src/main/java/software/amazon/smithy/codegen/core/directed/DirectedCodegen.java diff --git a/docs/source-2.0/guides/building-codegen/index.rst b/docs/source-2.0/guides/building-codegen/index.rst index 8277117aeac..e65155ee326 100644 --- a/docs/source-2.0/guides/building-codegen/index.rst +++ b/docs/source-2.0/guides/building-codegen/index.rst @@ -128,5 +128,5 @@ Navigation .. observability, Smithy reference architecture, paginators, .. waiters, endpoint resolution -.. _Smithy's Java reference implementation: https://github.com/awslabs/smithy +.. _Smithy's Java reference implementation: https://github.com/smithy-lang/smithy .. _Gradle: https://gradle.org diff --git a/docs/source-2.0/guides/building-codegen/making-codegen-pluggable.rst b/docs/source-2.0/guides/building-codegen/making-codegen-pluggable.rst index ddea2d5bc2b..33181f35ecf 100644 --- a/docs/source-2.0/guides/building-codegen/making-codegen-pluggable.rst +++ b/docs/source-2.0/guides/building-codegen/making-codegen-pluggable.rst @@ -68,7 +68,7 @@ Creating a ``SmithyIntegrations`` ================================= Smithy codegen provides a pre-built integration interface, -`SmithyIntegration `__, +`SmithyIntegration `__, that *should* be used by every Smithy code generator. Using this standardized interface ensures all code generators follow the same basic framework and makes it easier to contribute features that span multiple diff --git a/docs/source-2.0/guides/building-codegen/mapping-shapes-to-languages.rst b/docs/source-2.0/guides/building-codegen/mapping-shapes-to-languages.rst index 32f64c8915e..c1ffafc7336 100644 --- a/docs/source-2.0/guides/building-codegen/mapping-shapes-to-languages.rst +++ b/docs/source-2.0/guides/building-codegen/mapping-shapes-to-languages.rst @@ -391,7 +391,7 @@ Computing a service closure The closure of shapes connected to a service are the shapes that will be code generated. You can compute this closure using a -`Walker `__: +`Walker `__: .. code-block:: java @@ -451,7 +451,7 @@ A more recent feature of Smithy allows marking structures as specific to the input or output of an operation using ``@input`` and ``@output`` traits. You can transform the model being code generated and create synthetic input and output shapes when necessary using the -`createDedicatedInputAndOutput `_ +`createDedicatedInputAndOutput `_ model transformer. The following example creates a new Model that has dedicated input and output shapes for every operation, each marked with the ``@input`` or ``@output`` trait, and each uses a consistent name @@ -477,7 +477,7 @@ A *resource* is an entity with an identity that has a set of operations. Resources add hierarchy to a model. You will need to traverse from a service to every operation and resource in order to crawl the entire service. This process can be simplified using the -`TopDownIndex `__. +`TopDownIndex `__. Iterating only over the operations attached to a service will not provide every operation in the closure of the service. @@ -502,7 +502,7 @@ identify which member in a recursive loop needs to be heap allocated, implementations will need to utilize a topological sort. Smithy's :ref:`directedcodegen` abstraction will automatically generate code based on a topological sort, though generators that need more control over how to handle recursion will need to manually -use a `TopologicalIndex `__. +use a `TopologicalIndex `__. .. seealso:: @@ -531,7 +531,7 @@ Smithy has different rules around when a member is always present or optional. The rules around nullability are defined in the Smithy specification. However, all of this complexity is accounted for automatically using the -`NullableIndex `_. +`NullableIndex `_. .. code-block:: java diff --git a/docs/source-2.0/guides/building-codegen/overview-and-concepts.rst b/docs/source-2.0/guides/building-codegen/overview-and-concepts.rst index 109ccecd63c..56163e7fe59 100644 --- a/docs/source-2.0/guides/building-codegen/overview-and-concepts.rst +++ b/docs/source-2.0/guides/building-codegen/overview-and-concepts.rst @@ -44,7 +44,7 @@ client using the ``foo-client-codegen`` plugin found on the classpath. .. seealso:: - `Smithy Gradle plugin `__ - - `DirectedCodegen `__ + - `DirectedCodegen `__ to more easily implement codegen - :doc:`configuring-the-generator` @@ -218,7 +218,7 @@ Type generation Smithy code generators can generate standalone types. For example, this would happen when a service has no operations or resources but only shapes bound to the service via the (upcoming) -`shapes property `__. +`shapes property `__. - Generation of types should still require a service shape that is used to create a closure of shapes. diff --git a/docs/source-2.0/guides/evolving-models.rst b/docs/source-2.0/guides/evolving-models.rst index 4217765c84f..f6e68f7ad0a 100644 --- a/docs/source-2.0/guides/evolving-models.rst +++ b/docs/source-2.0/guides/evolving-models.rst @@ -147,6 +147,6 @@ The following changes to trait definitions are backward compatible: Using Smithy Diff ================= -`Smithy Diff `_ is a +`Smithy Diff `_ is a tool used to compare two Smithy models to check for backward compatibility issues. Smithy Diff can be run via a Java library or via the Smithy CLI. diff --git a/docs/source-2.0/guides/glossary.rst b/docs/source-2.0/guides/glossary.rst index f6ef6416e6d..49829395e77 100644 --- a/docs/source-2.0/guides/glossary.rst +++ b/docs/source-2.0/guides/glossary.rst @@ -9,7 +9,7 @@ Glossary AbstractCodeWriter A Java class in the :term:`Smithy reference implementation` used to generate code for a :term:`target environment`. Find the - `source code on GitHub `__. + `source code on GitHub `__. codegen Code generation @@ -20,7 +20,7 @@ Glossary :term:`target environment`. codegen-core - A `set of Java libraries `__ + A `set of Java libraries `__ built on top of the :term:`Smithy reference implementation` that are used to implement Smithy code generators. codegen-core contains libraries for writing code, managing dependencies, managing imports, @@ -149,6 +149,6 @@ Glossary and style. Code generators use traits to influence generated code. -.. _HttpBindingIndex: https://github.com/awslabs/smithy/blob/main/smithy-model/src/main/java/software/amazon/smithy/model/knowledge/HttpBindingIndex.java -.. _NullableIndex: https://github.com/awslabs/smithy/blob/main/smithy-model/src/main/java/software/amazon/smithy/model/knowledge/NullableIndex.java -.. _Model class: https://github.com/awslabs/smithy/blob/main/smithy-model/src/main/java/software/amazon/smithy/model/Model.java +.. _HttpBindingIndex: https://github.com/smithy-lang/smithy/blob/main/smithy-model/src/main/java/software/amazon/smithy/model/knowledge/HttpBindingIndex.java +.. _NullableIndex: https://github.com/smithy-lang/smithy/blob/main/smithy-model/src/main/java/software/amazon/smithy/model/knowledge/NullableIndex.java +.. _Model class: https://github.com/smithy-lang/smithy/blob/main/smithy-model/src/main/java/software/amazon/smithy/model/Model.java diff --git a/docs/source-2.0/guides/smithy-cli/cli_installation.rst b/docs/source-2.0/guides/smithy-cli/cli_installation.rst index 20d1b2ece77..dcc570e3c58 100644 --- a/docs/source-2.0/guides/smithy-cli/cli_installation.rst +++ b/docs/source-2.0/guides/smithy-cli/cli_installation.rst @@ -1,6 +1,6 @@ .. _cli_installation: -.. |release-uri| replace:: https://github.com/awslabs/smithy/releases/download/__smithy_version__ +.. |release-uri| replace:: https://github.com/smithy-lang/smithy/releases/download/__smithy_version__ .. |mac-tar| replace:: smithy-cli-darwin-x86_64.tar.gz .. |mac-arm-tar| replace:: smithy-cli-darwin-aarch64.tar.gz .. |linux-tar| replace:: smithy-cli-linux-x86_64.tar.gz @@ -502,7 +502,7 @@ We'll be using these to perform the verification. `key validation`_ section from the GNU Privacy Handbook. -.. _Smithy GitHub releases: https://github.com/awslabs/smithy/releases +.. _Smithy GitHub releases: https://github.com/smithy-lang/smithy/releases .. _AWS Homebrew Tap: https://github.com/aws/homebrew-tap -.. _release: https://github.com/awslabs/smithy/releases/download/__smithy_version__ +.. _release: https://github.com/smithy-lang/smithy/releases/download/__smithy_version__ .. _key validation: https://www.gnupg.org/gph/en/manual/x334.html diff --git a/docs/source-2.0/guides/smithy-cli/index.rst b/docs/source-2.0/guides/smithy-cli/index.rst index 8e2a6e0bcfd..69ef5f7c445 100644 --- a/docs/source-2.0/guides/smithy-cli/index.rst +++ b/docs/source-2.0/guides/smithy-cli/index.rst @@ -17,7 +17,7 @@ utilizing the CLI to its full potential. If you have suggestions on how to improve the CLI or run into issues, please create an issue in the `Smithy GitHub repository -`_. +`_. .. toctree:: :maxdepth: 1 diff --git a/docs/source-2.0/index.rst b/docs/source-2.0/index.rst index a80163a80d6..876806af59c 100644 --- a/docs/source-2.0/index.rst +++ b/docs/source-2.0/index.rst @@ -28,7 +28,7 @@ Smithy .. rubric:: Next steps * Find out more about Smithy models and this example in the :doc:`quickstart`. -* Find the source code on `Github `_. +* Find the source code on `Github `_. Features @@ -148,6 +148,6 @@ Read more :caption: Project :maxdepth: 1 - Source code + Source code Awesome Smithy 1.0 Documentation diff --git a/docs/source-2.0/spec/index.rst b/docs/source-2.0/spec/index.rst index 395ff818e3b..df0ba716ae0 100644 --- a/docs/source-2.0/spec/index.rst +++ b/docs/source-2.0/spec/index.rst @@ -18,7 +18,7 @@ This specification makes use of the Augmented Backus-Naur Form (ABNF) of that document. Please report technical errors and ambiguities in this specification to the -Smithy GitHub repository at https://github.com/awslabs/smithy. +Smithy GitHub repository at https://github.com/smithy-lang/smithy. This specification is open source; contributions are welcome. .. rubric:: Examples diff --git a/docs/source-2.0/spec/selectors.rst b/docs/source-2.0/spec/selectors.rst index fd263a3d3ac..6da109b7c54 100644 --- a/docs/source-2.0/spec/selectors.rst +++ b/docs/source-2.0/spec/selectors.rst @@ -1814,7 +1814,7 @@ Below is an example selector compliance test: string AtLeastTen The compliance tests can also be accessed in this -`directory `__ +`directory `__ of the Smithy Github repository. diff --git a/docs/source-shared/ts-ssdk/validation.rst b/docs/source-shared/ts-ssdk/validation.rst index b7749962a7a..5eb8ceba055 100644 --- a/docs/source-shared/ts-ssdk/validation.rst +++ b/docs/source-shared/ts-ssdk/validation.rst @@ -132,4 +132,4 @@ the developer can still use Smithy's built in validation, but return ``BadInput` }; }); -.. _smithy.framework#ValidationException: https://github.com/awslabs/smithy/blob/main/smithy-validation-model/model/smithy.framework.validation.smithy#L9 +.. _smithy.framework#ValidationException: https://github.com/smithy-lang/smithy/blob/main/smithy-validation-model/model/smithy.framework.validation.smithy#L9