Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change some docs organization and titles #2097

Merged
merged 1 commit into from
Jan 12, 2024
Merged

Change some docs organization and titles #2097

merged 1 commit into from
Jan 12, 2024

Conversation

mtdowling
Copy link
Member

This change makes some minor changes to how the guides section of the docs is laid out.

  1. Rather than group the Gradle plugin and smithy-build.json under building models, they are now top-level docs alongside the top-level CLI docs. This removes the incongruence of grouping Gradle with the config docs while not including the CLI. I've also renamed the docs on the config file to smithy-build.json. Redirects were added to maintain existing links.
  2. Docs for converting to OpenAPI, converting from 1.0 to 2.0, and converting to CloudFormation resource schemas were moved under a sub-guide called Model Translations. This moves these very specific and probably ever growing category of docs into their our guide. Redirects were added as well.
  3. Added links to the CLI and smithy-examples to the quickstart.
  4. Renamed Model Linters to Linting Models.
  5. Renaming "Using Smithy Code Generation" to the less verbose title of "Code Generation". This shouldn't confuse people with how to build a code generator since that's called "Creating a Code Generator".

Issue #, if available:

Description of changes:

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

This change makes some minor changes to how the guides section of
the docs is laid out.

1. Rather than group the Gradle plugin and smithy-build.json under
   building models, they are now top-level docs alongside the
   top-level CLI docs. This removes the incongruence of grouping
   Gradle with the config docs while not including the CLI. I've also
   renamed the docs on the config file to smithy-build.json.
   Redirects were added to maintain existing links.
2. Docs for converting to OpenAPI, converting from 1.0 to 2.0, and
   converting to CloudFormation resource schemas were moved under
   a sub-guide called Model Translations. This moves these very
   specific and probably ever growing category of docs into their
   our guide. Redirects were added as well.
3. Added links to the CLI and smithy-examples to the quickstart.
4. Renamed Model Linters to Linting Models.
5. Renaming "Using Smithy Code Generation" to the less verbose title
   of "Code Generation". This shouldn't confuse people with how
   to build a code generator since that's called
   "Creating a Code Generator".
@mtdowling mtdowling requested a review from a team as a code owner January 12, 2024 16:57
@mtdowling mtdowling merged commit 6418c56 into main Jan 12, 2024
11 checks passed
@mtdowling mtdowling deleted the organize-docs branch September 22, 2024 00:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants