Skip to content

Conversation

@albertoramosmonagas
Copy link
Contributor

@albertoramosmonagas albertoramosmonagas commented May 13, 2025

What type of PR is this?

  • documentation
  • cleanup
  • repository management

What this PR does / why we need it:

This PR improves the onboarding experience and documentation for the PredictiveConnectivityData API repository. Specifically, it:

  • Updates the README.md:
    • Adds a detailed Scope section describing the API's purpose and use cases.
    • Completes the Contributing section with meeting schedule, registration link, mailing list, and link to 2025 meeting minutes.
  • Removes the outdated README.md from the supporting-documents folder.
  • Adds the Kick Off session presentation as a PDF in supporting-documents.
  • Add maintainer section

These changes help new contributors quickly understand the context, join calls, and find relevant documentation.

Which issue(s) this PR fixes:

Fixes #4
Fixes #2
Fixes camaraproject/APIBacklog#191

Special notes for reviewers:

Please validate the meeting information and links to CAMARA Wiki are correct and up to date.

Changelog input

 release-note

Additional documentation

This section can be blank.

docs

@albertoramosmonagas
Copy link
Contributor Author

The only pending task is to update the meeting cadence once it's confirmed.

It should be added in the CAMARA Wiki here:
🔗 https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/119996417/PredictiveConnectivityData
→ in the section: Meetings | Registration / Join (TBD)

It should also be updated in the GitHub README.md under the Contributing section.

Once both updates are done, we can close this issue:
#2

@albertoramosmonagas albertoramosmonagas marked this pull request as draft May 13, 2025 14:19
Copy link
Contributor

@hdamker hdamker left a comment

Choose a reason for hiding this comment

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

I'm aware that the PR is not yet ready for review ... just two comments from my side upfront.

albertoramosmonagas and others added 5 commits May 14, 2025 10:50
Use the month the repository was created, and not the time of the proposal

Co-authored-by: Herbert Damker <herbert.damker@telekom.de>
@hdamker
Copy link
Contributor

hdamker commented May 21, 2025

Just the hint that smaller PRs which are addressing one aspect at the time are easier to manage an won't stay open a longer time.

@albertoramosmonagas
Copy link
Contributor Author

Just the hint that smaller PRs which are addressing one aspect at the time are easier to manage an won't stay open a longer time.

Totally agree with you herbert, in this case we are blocked because we have no answer to get the link to the meeting cadence, it is the only thing left of the PR.

@hdamker
Copy link
Contributor

hdamker commented May 22, 2025

Totally agree with you herbert, in this case we are blocked because we have no answer to get the link to the meeting cadence, it is the only thing left of the PR.

Please ping / remind support@camaraproject.org to get the link. And consider to merge now and do the remaining update when the information is available.

@albertoramosmonagas albertoramosmonagas marked this pull request as ready for review May 22, 2025 14:34
@albertoramosmonagas albertoramosmonagas requested a review from a team as a code owner May 22, 2025 14:34
Copy link
Contributor

@hdamker hdamker left a comment

Choose a reason for hiding this comment

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

LGTM

@albertoramosmonagas albertoramosmonagas self-assigned this May 27, 2025
@hdamker
Copy link
Contributor

hdamker commented May 28, 2025

Just realized that the PR also contains changes to the MAINTAINERS.MD file. That should be done better in a separate PR with an explicit title as it needs some background work by the admin team (for that reason the admin team is also codeowner of the file).

But as we are here and have all approvals (except @eric-murray as codeowner, but I assume that he is fine with the PR): I added @eric-murray @albertoramosmonagas @sachinvodafone and @Noel-Wirzius-DT to @camaraproject/predictive-connectivity-data_maintainers and invited @VGF-TEF to the CAMARA organization as pending member of the team. Please accept the invitation and welcome!

@hdamker hdamker merged commit 9463cfa into main May 28, 2025
1 check passed
@hdamker hdamker deleted the docs/issue4-update-readme-onboarding branch May 28, 2025 17:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

5 participants