Skip to content
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

Updated docs based on latest Score release #60

Merged
merged 2 commits into from
Oct 9, 2023
Merged

Conversation

sujaya-sys
Copy link
Contributor

@sujaya-sys sujaya-sys commented Oct 5, 2023

Updated docs based on latest release v.0.8.0:

Not included:

  • For score-humanitec, a "humanitec.io/managed-by": "score-humanitec" annotation is automatically injected which ensures that an according hint is presented in the Humanitec UI.
  • The follow up fix on the --message parameter (deployment's comment with --message score-humanitec#57) is already documented for the delta and message command

Copy link
Contributor

@chrishumanitec chrishumanitec left a comment

Choose a reason for hiding this comment

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

A few small changes. Otherwise good.

@@ -244,6 +246,8 @@ readinessProbe:
- `target`: specifies a path and name.
- `mode`: specifies access mode.
- `content`: specifies inline content and supports templates.
Copy link
Contributor

Choose a reason for hiding this comment

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

Exactly one of content or source must be specified.

Suggest:

  • content: specifies inline content and supports templates. Exactly one of content or source must be defined.

@@ -244,6 +246,8 @@ readinessProbe:
- `target`: specifies a path and name.
- `mode`: specifies access mode.
- `content`: specifies inline content and supports templates.
- `source`: specifies a path to a file to make available.
Copy link
Contributor

Choose a reason for hiding this comment

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

Exactly one of content or source must be specified.

Suggest:

  • source: specifies a path to a file to make available. Exactly one of content or source must be defined.

@@ -244,6 +246,8 @@ readinessProbe:
- `target`: specifies a path and name.
- `mode`: specifies access mode.
- `content`: specifies inline content and supports templates.
- `source`: specifies a path to a file to make available.
- `noExpand`: If true, placeholder expansion will not occur in the `content`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Is not super clear. Would suggest the more clear:

  • noExpand: If true, the content or file referenced in source will be used literally with no placeholder expansion in the running container.

Copy link
Contributor

@chrishumanitec chrishumanitec left a comment

Choose a reason for hiding this comment

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

LGTM

@sujaya-sys sujaya-sys merged commit 7353ace into main Oct 9, 2023
1 check passed
@sujaya-sys sujaya-sys deleted the release-v.0.8.0 branch October 9, 2023 12:14
@sujaya-sys sujaya-sys restored the release-v.0.8.0 branch October 9, 2023 12:14
@sujaya-sys sujaya-sys deleted the release-v.0.8.0 branch October 9, 2023 12:14
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