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.

Sign up for GitHub

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

Jump to bottom

Add documentation for sourceUrl and releaseTimestamp fields #29186

Closed
HonkingGoose opened this issue May 21, 2024 · 3 comments
Closed

Add documentation for sourceUrl and releaseTimestamp fields #29186

HonkingGoose opened this issue May 21, 2024 · 3 comments
Labels
duplicate This issue is closed as a duplicate of another issue priority-3-medium Default priority, "should be done" but isn't prioritised ahead of others type:docs Documentation

Comments

@HonkingGoose
Copy link
Collaborator

Describe the proposed change(s).

Related PR:

Changes

  • Added sourceUrlSupport/Note and releaseTimestampSupport/Note fields based on the return object of each datasource

We need to add documentation for this new feature/behavior, so probably:

  • explain what it is
  • explain what it does
  • explain when to use it
  • explain when not to use it
  • if needed, warn users about possible logic/bugged behavior
  • give examples of correct configuration/behavior

I don't know what's the best/correct place to put this information.

I'll let @RahulGautamSingh (PR creator), or another maintainer work on this issue. 😉
@HonkingGoose HonkingGoose added priority-3-medium Default priority, "should be done" but isn't prioritised ahead of others type:docs Documentation labels May 21, 2024
@HonkingGoose HonkingGoose mentioned this issue May 21, 2024
Merged
6 tasks
@RahulGautamSingh
Copy link
Collaborator

RahulGautamSingh commented May 21, 2024 •
edited

Duplicate: #28948 ?

I think Rhys meant that in the datasource docs we should integrate info about releaseTimestamp and sourceUrl like we do for customRegistrySupport.

@rarkins
Copy link
Collaborator

rarkins commented May 22, 2024

Yes, I forgot that one existed

@rarkins rarkins closed this as not planned Won't fix, can't repro, duplicate, stale May 22, 2024
@HonkingGoose
Copy link
Collaborator Author

Duplicate of #28948

@HonkingGoose HonkingGoose marked this as a duplicate of #28948 May 22, 2024
@HonkingGoose HonkingGoose added the duplicate This issue is closed as a duplicate of another issue label May 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
duplicate This issue is closed as a duplicate of another issue priority-3-medium Default priority, "should be done" but isn't prioritised ahead of others type:docs Documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@rarkins @HonkingGoose @RahulGautamSingh