Skip to content

docs: update copyright notice to align with AWS documentation standards #4419

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Sep 4, 2025
Merged

docs: update copyright notice to align with AWS documentation standards #4419

merged 1 commit into from
Sep 4, 2025
+8 −1

Conversation

dcabib
Copy link
Contributor

@dcabib dcabib commented Sep 4, 2025 •
edited
Loading

Summary

Changes

This PR updates the documentation copyright notice in mkdocs.yml to align with AWS documentation standards as requested in issue #4417.

Issue number: closes #4417

Changes Made

  • Replace simple copyright line with comprehensive footer
  • Add Privacy and Site terms links with proper target="_blank" and rel="nofollow" attributes
  • Update copyright format to match AWS documentation patterns
  • Align with Java implementation for consistency across Powertools languages

Before

copyright: Copyright © 2025 Amazon Web Services

After

copyright: |
  <div id="awsdocs-legal-zone-copyright">
      <a href="https://aws.amazon.com/privacy" target="_blank" rel="nofollow">Privacy</a> |
      <a href="https://aws.amazon.com/terms/" target="_blank" rel="nofollow">Site terms</a> |
      <span class="copyright">
        © 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved.
      </span>
  </div>

Cross-Project Consistency

I verified the copyright format across all Powertools projects:

  • ✅ TypeScript (this PR): Updated to new format
  • ✅ Java: Already has the new format (matches this implementation exactly)
  • ❌ Python: Still has old format - needs similar update
  • ❌ .NET: Still has old format - needs similar update

Testing

  • ✅ Documentation builds successfully with npm run docs:local:run
  • ✅ MkDocs processes the new copyright format without errors
  • ✅ New footer will display Privacy and Site terms links as required

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@dcabib
docs: update copyright notice to align with AWS documentation standards
cacde62 
- Replace simple copyright line with comprehensive footer
- Add Privacy and Site terms links with proper attributes
- Update copyright format to match AWS documentation patterns
- Align with Java implementation for consistency across Powertools

Fixes aws-powertools#4417
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Sep 4, 2025
@pull-request-size pull-request-size bot added the size/XS PR between 0-9 LOC label Sep 4, 2025
@sonarqubecloud SonarQubeCloud
Copy link

sonarqubecloud bot commented Sep 4, 2025

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

dreamorosi
dreamorosi approved these changes Sep 4, 2025
View reviewed changes
Copy link
Contributor

@dreamorosi dreamorosi left a comment

Choose a reason for hiding this comment

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

Thank you!

@dreamorosi
Copy link
Contributor

A note for next time: since you tested the change, in the case of docs it'd be useful to reviewers if you could paste a screenshot of the change

@dreamorosi dreamorosi merged commit 6d45d58 into aws-powertools:main Sep 4, 2025
42 checks passed
@dcabib
Copy link
Contributor Author

dcabib commented Sep 4, 2025

Understood and noted...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@dreamorosi dreamorosi dreamorosi approved these changes

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation size/XS PR between 0-9 LOC

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Maintenance: Update Documentation Copyright notice

2 participants

@dcabib @dreamorosi