Skip to content
This repository has been archived by the owner on Jan 13, 2021. It is now read-only.

Fix documentation about references #309

Merged
merged 1 commit into from
Aug 20, 2018
Merged

Fix documentation about references #309

merged 1 commit into from
Aug 20, 2018

Conversation

ash2k
Copy link
Contributor

@ash2k ash2k commented Aug 19, 2018

Fixes #267.

@ash2k ash2k self-assigned this Aug 19, 2018
@ash2k ash2k requested a review from a team August 19, 2018 17:29
Annotations: map[string]string{
"Secret": "{{" + resSb1 + ":bindsecret#Data.mysecret}}",
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This test should have been failing but it was not. Bundle was updated to add the missing finalizer (see around line 64) and the reference was not processed. In fact, the reference format is old here - test test should have been updated when the references refactoring was performed. I've expanded this test to assert the bundle conditions to make sure it does not regress in the future. Also checked if all other tests do have the finalizer specified (there is one that does not intentionally - it tests the the finalizer is added).

```

## Referring to ServiceBinding outputs

When Service Catalog processes a ServiceBinding, the output is placed in a Secret
When Service Catalog processes a `ServiceBinding`, the output is placed in a `Secret`
(since they might be secret). If they're not secret, it's convenient to directly
Copy link
Contributor

Choose a reason for hiding this comment

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

"they may contain sensitive data"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This text is originally from James, so I'm confident it is grammatically correct 😛

Copy link
Contributor

Choose a reason for hiding this comment

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

Don't trust me! I am super-prone to making mistakes. I type slightly more quickly than I think in most cases.

But I think Nail here is not suggesting a grammatical change, but one which avoids the confusion of Secret vs secret, which I probably wrote just because it amused me. His version is better!

@nilebox
Copy link
Contributor

nilebox commented Aug 20, 2018

@ash2k you need to run make check to see linter errors.

@ash2k ash2k merged commit 36b0def into master Aug 20, 2018
@ash2k ash2k deleted the fix-readme branch August 20, 2018 09:06
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants