-
Notifications
You must be signed in to change notification settings - Fork 1
docs: update README with onboarding info and kick off PDF #5
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
Conversation
|
The only pending task is to update the meeting cadence once it's confirmed. It should be added in the CAMARA Wiki here: It should also be updated in the GitHub README.md under the Contributing section. Once both updates are done, we can close this issue: |
hdamker
left a comment
There was a problem hiding this 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.
Use the month the repository was created, and not the time of the proposal Co-authored-by: Herbert Damker <herbert.damker@telekom.de>
|
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. |
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. |
hdamker
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
|
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! |
What type of PR is this?
What this PR does / why we need it:
This PR improves the onboarding experience and documentation for the PredictiveConnectivityData API repository. Specifically, it:
README.md:README.mdfrom thesupporting-documentsfolder.supporting-documents.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
Additional documentation
This section can be blank.