Skip to content

Add SDK version number to all API Reference doc pages #1836

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

Merged
merged 2 commits into from
May 14, 2020
Merged

Add SDK version number to all API Reference doc pages #1836

merged 2 commits into from
May 14, 2020

Conversation

Carey-AWS
Copy link
Contributor

Description

Added AWS SDK for Java version number to the v2 API docs via POM configuration. (Also cleaned up the formatting of the footer, and made its year permanently up-to-date.)

Motivation and Context

Customers often come across a code snippet for the SDK for Java that links off to the API Reference materials. However, they don't know which version of the SDK it's for (v1 or v2) because only the main overview page shows this detail.

Testing

Local build

Screenshots (if appropriate)

version-in-javadocs

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)

Checklist

  • I have read the CONTRIBUTING document
  • Local run of mvn install succeeds
  • My code follows the code style of this project
  • My change requires a change to the Javadoc documentation
  • I have updated the Javadoc documentation accordingly
  • I have read the README document
  • I have added tests to cover my changes
  • All new and existing tests passed
  • A short description of the change has been added to the CHANGELOG
  • My change is to implement 1.11 parity feature and I have updated LaunchChangelog

License

  • I confirm that this pull request can be released under the Apache 2 license

Comment on lines -1062 to +1065
<bottom><![CDATA[Copyright &#169; 2019 Amazon Web Services, Inc. All Rights Reserved.]]></bottom>
<header><![CDATA[<h1>AWS SDK for Java API Reference - ${project.version}</h1>]]></header>
<footer><![CDATA[&nbsp;]]></footer>
<bottom><![CDATA[<h2 style="float:left;padding-left:8px;clear:both;">Copyright &#169; ${maven.build.timestamp} Amazon Web Services, Inc. All Rights Reserved.</h2>]]></bottom>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice catch on the date!

@millems millems merged commit 17b47ac into aws:master May 14, 2020
@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities (and Security Hotspot 0 Security Hotspots to review)
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

aws-sdk-java-automation added a commit that referenced this pull request Nov 12, 2021
…e2ba0e1d9

Pull request: release <- staging/f408fde2-62db-49ca-a34d-f52e2ba0e1d9
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