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

fix: corrected resource annotations page #62

Merged
merged 2 commits into from
Oct 25, 2023

Conversation

chrishumanitec
Copy link
Contributor

Thank you for submitting this pull request! We appreciate you spending the time to work on these changes.

What is the motivation?

The description of resource annotations was not entirely correct:

  • They were described simply as "annotations" but they are specific to resources
  • It was suggested that anotations could be used to supply metadat to resources when they actually provide metadata about resources for a specific score implementation.
  • The examples included the deprecated properties property in the resource object.

What does this change do?

Re-writes some of teh sections and renames the title from "Annotations" to "Resource Annotations".

What is your testing strategy?

The page will be proofread as part of the PR review.

Is this related to any issues?

No.

Have you read the Contributing Guidelines?

Signed-off-by: Tobias Babin <140624220+TobiasBabin@users.noreply.github.com>
@chrishumanitec chrishumanitec merged commit fb6f870 into main Oct 25, 2023
1 check passed
@chrishumanitec chrishumanitec deleted the update-resource-annotations branch October 25, 2023 14:10
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