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

Draft: docs: enhancement of the data plane signaling protocol doc #4284

Closed

Conversation

f-zimmer
Copy link

What this PR changes/adds

The PR adds some further info about the Data Plane Signaling, especially in regards to the Data planes internal state machine and the message layout.

Why it does that

After having had a first read of the current state of the DPS doc, it was hard to understand how the messages are structured, where to find them and what the actual interaction between CP and DP would look like. After having crawled through the source code I enhanced the doc by adding my newly gained insights in order to keep others from needing to do the same.

Further notes

Added the diagrams as plantuml in order to be easily maintainable in the future.

Linked Issue(s)

None

Please be sure to take a look at the contributing guidelines and our etiquette for pull requests.

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

We are always happy to welcome new contributors ❤️ To make things easier for everyone, please make sure to follow our contribution guidelines, check if you have already signed the ECA, and relate this pull request to an existing issue or discussion.

@f-zimmer f-zimmer changed the title docs: enhancement of the data plane signaling protocol doc Draft: docs: enhancement of the data plane signaling protocol doc Jun 19, 2024
@f-zimmer f-zimmer marked this pull request as draft June 19, 2024 07:56
@paullatzelsperger
Copy link
Member

paullatzelsperger commented Jun 19, 2024

I understand that this PR is still in draft, but I strongly recommend familiarizing yourself with our contribution guidelines, that explicitly state "No surprise PRs".

Unless you formulate your intent in a discussion or an issue, clearly outlining pain points, motivating the change and a drafting a proposed solution, the chances of anyone reviewing this are slim, to say the least.

[edit]: I can already tell you that "because I found it too hard to understand" is not a good-enough reason.

The fact that you are proposing changes to spec documents raises the bar even more.

@f-zimmer f-zimmer closed this Jun 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants