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

Review issues for event-subscription-template.yaml #395

Open
rartych opened this issue Jan 28, 2025 · 2 comments · May be fixed by #409
Open

Review issues for event-subscription-template.yaml #395

rartych opened this issue Jan 28, 2025 · 2 comments · May be fixed by #409
Labels
correction correction in documentation Spring25

Comments

@rartych
Copy link
Collaborator

rartych commented Jan 28, 2025

Problem description
Issues indicated with r2.2 review:

  • Release 2.2 #388 (comment)
    • line 19: should this URL be adapted to point to the API repository of the API using the template ?
      maybe it was discussed already.
  • Release 2.2 #388 (comment)
    • line 528: the link should be relative to the release, or could be changed to textual reference without an actual link.

Expected behavior
Agreed corrections need to be applied to the file before public release.

@rartych rartych added the correction correction in documentation label Jan 28, 2025
@rartych rartych mentioned this issue Jan 28, 2025
2 tasks
@PedroDiez
Copy link
Collaborator

Some feedback:

  • First comment: yep it is a placeholder that is replace when this template is used for a given API design and therefore the value is replaced. Maybe adding a note in the template to mention that
  • Second comment: Agree to make a reference with relative link so as in that way it will refer the status reached in a specific release

@bigludo7
Copy link
Collaborator

bigludo7 commented Feb 5, 2025

For the first point agreed with @PedroDiez - we can add a note in the documentation part
For the second point I'm fine with the solution proposed by Pedro or to simply remove the link to the design guideline (but of course keeping in the text the reference to the guideline).

@PedroDiez PedroDiez linked a pull request Feb 5, 2025 that will close this issue
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
correction correction in documentation Spring25
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants