Skip to content

docs: enhance the example of PushSecret/ClusterPushSecret#4872

Merged
Skarlso merged 2 commits intoexternal-secrets:mainfrom
aabouzaid:add-pushsecret-templating-example
Jun 6, 2025
Merged

docs: enhance the example of PushSecret/ClusterPushSecret#4872
Skarlso merged 2 commits intoexternal-secrets:mainfrom
aabouzaid:add-pushsecret-templating-example

Conversation

@aabouzaid
Copy link
Copy Markdown
Contributor

@aabouzaid aabouzaid commented Jun 5, 2025

Problem Statement

This PR fixes a couple of issues related to the docs of PushSecret and ClusterPushSecret:

  1. The example is unclear, as the same key is used for source, destination, and within the resource.
  2. Part of the example is unfunctional. Accessing a YAML key with a dash will fail with the following error unless the index function is used.
  3. Unify the style of PushSecret as it doesn't follow the same structure as the other pages under the same section.

Related Issue

Maybe not directly related, but Google sends people to this issue #3443, and with the unfunctional example, the users could think it's related to that bug.

Proposed Changes

Make it easier and more intuitive to use PushSecret/ClusterPushSecret.

Checklist

  • I have read the contribution guidelines
  • All commits are signed with git commit --signoff
  • My changes have reasonable test coverage (N/A)
  • All tests pass with make test
  • I ensured my PR is ready for review with make reviewable

@aabouzaid aabouzaid requested a review from a team as a code owner June 5, 2025 03:00
@aabouzaid aabouzaid requested a review from knelasevero June 5, 2025 03:00
@aabouzaid aabouzaid force-pushed the add-pushsecret-templating-example branch 2 times, most recently from df78f27 to 3891708 Compare June 5, 2025 03:02
Signed-off-by: Ahmed AbouZaid <6760103+aabouzaid@users.noreply.github.com>
@Skarlso Skarlso merged commit 3266ddb into external-secrets:main Jun 6, 2025
2 checks passed
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud bot commented Jun 6, 2025

pepordev pushed a commit to pepordev/external-secrets that referenced this pull request Jun 11, 2025
…ecrets#4872)

Signed-off-by: Ahmed AbouZaid <6760103+aabouzaid@users.noreply.github.com>
Co-authored-by: Gergely Brautigam <182850+Skarlso@users.noreply.github.com>
Signed-off-by: Pedro Parra Ortega <pedro.parraortega@enreach.com>
alliseeisgold pushed a commit to alliseeisgold/external-secrets that referenced this pull request Jul 10, 2025
…ecrets#4872)

Signed-off-by: Ahmed AbouZaid <6760103+aabouzaid@users.noreply.github.com>
Co-authored-by: Gergely Brautigam <182850+Skarlso@users.noreply.github.com>
Signed-off-by: asrormirzoev <asrormirzoev@yandex-team.ru>
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