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

TI API: Changelog #295

Open
FabrizioMoggio opened this issue Sep 12, 2024 · 7 comments
Open

TI API: Changelog #295

FabrizioMoggio opened this issue Sep 12, 2024 · 7 comments
Labels
documentation Indicating issues with API documentation or supplementary documents Traffic Influence API

Comments

@FabrizioMoggio
Copy link
Collaborator

Problem description
The changelog is in the YAML instead it should be in the Changelog.md file

Expected action
Remove the changelog from the YAML file

@FabrizioMoggio FabrizioMoggio added documentation Indicating issues with API documentation or supplementary documents Traffic Influence API labels Sep 12, 2024
@hdamker
Copy link
Collaborator

hdamker commented Sep 16, 2024

@FabrizioMoggio my strong recommendation is still to ask for an own repository for the API. It might get more and more difficult to try to provide the release assets for the API within the current repository. To prepare for that you need at least a tagged version here (which you can refer to later in the new repository).

@FabrizioMoggio
Copy link
Collaborator Author

@hdamker is there a documented procedure to get a dedicated repository?

@FabrizioMoggio
Copy link
Collaborator Author

The removal of the changelog from the YAML was implemented in #296
To close this issue a changelog.md file must be created.

@hdamker
Copy link
Collaborator

hdamker commented Oct 29, 2024

@hdamker is there a documented procedure to get a dedicated repository?

Please create an issue within API Backlog (see camaraproject/APIBacklog#37 as an example). You can refer to https://github.com/camaraproject/APIBacklog/blob/main/documentation/API%20proposals/APIproposal_Traffic%20Influence_TIM.md. Please add in the issue also the initial Codeowners and Maintainers (I suppose it will be subset out of the EdgeCloud ones).

For the transfer of your code to the new repository, you should take a tagged version here in EdgeCloud (which you can refer to within the new repository).

cc: @jgarciahospital

@FabrizioMoggio
Copy link
Collaborator Author

Before proceeding I would like to coordinate with the Edge Cloud WG

@FabrizioMoggio
Copy link
Collaborator Author

I think the changelog and the tagged release con be produced when the API is stable enough. In my opinion when this list of activities is completed: #282

It anyway good to start a discussion on the creation of a specific repository for the TI API still as part of the Edge Cloud Family

@FabrizioMoggio
Copy link
Collaborator Author

Discussion started: #313

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Indicating issues with API documentation or supplementary documents Traffic Influence API
Projects
None yet
Development

No branches or pull requests

2 participants