Skip to content

Comments

docs: clarify Defender Deploy Environment API keys#1155

Merged
CoveMB merged 3 commits intoOpenZeppelin:masterfrom
robaribas:docs/clarify-defender-api-keys
May 9, 2025
Merged

docs: clarify Defender Deploy Environment API keys#1155
CoveMB merged 3 commits intoOpenZeppelin:masterfrom
robaribas:docs/clarify-defender-api-keys

Conversation

@robaribas
Copy link
Contributor

Description

This PR addresses the issue described in #996 by clarifying that the API keys referenced in the Defender integration documentation are specifically from the Production or Test Deploy Environment that was configured in Defender.

Changes made:

  • Updated defender-deploy.adoc to add a note explaining that the API keys are specifically from the Deploy Environment
  • Updated foundry-defender.adoc to clarify that the API keys are from the Deploy Environment
  • Added links to the Defender tutorial's environment setup documentation in both files

Fixes

Closes #996

Checklist

  • Documentation update only
  • Links to relevant documentation added
  • Maintained consistent style with existing documentation

@robaribas robaribas force-pushed the docs/clarify-defender-api-keys branch from 08b14aa to 97ca38f Compare May 8, 2025 13:57
@robaribas
Copy link
Contributor Author

@ericglau @Amxx I've added the changes required to resolve #996 . Please have a look when you're free.

@ericglau ericglau requested a review from CoveMB May 8, 2025 15:17
Co-authored-by: Cove Marquis-Bortoli <44323490+CoveMB@users.noreply.github.com>
@robaribas
Copy link
Contributor Author

@CoveMB committed your suggestions. I think its good to go now.

@robaribas
Copy link
Contributor Author

The CI test passed. 🚀
@CoveMB Should I wait till openzeppelin-foundry-upgrades#107 gets merged as @ericglau mentioned something about docs/modules/ROOT/pages/foundry/pages/foundry-defender.adoc being automatically filled from openzeppelin-foundry-upgrades

btw, Thanks for taking time to review this. ❤️

@ericglau
Copy link
Member

ericglau commented May 9, 2025

the PRs can be merged independently, thanks

@CoveMB CoveMB enabled auto-merge (squash) May 9, 2025 20:16
@CoveMB CoveMB merged commit 213169a into OpenZeppelin:master May 9, 2025
13 checks passed
@robaribas robaribas deleted the docs/clarify-defender-api-keys branch May 9, 2025 22:22
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.

Clarify Defender integration docs for API keys

4 participants