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

doc: proposal for nat address discovery #4560

Merged
merged 17 commits into from
Sep 23, 2024
Merged

Conversation

tzaeschke
Copy link
Contributor

@tzaeschke tzaeschke commented Jul 1, 2024

Proposal for NAT address discovery. Original discussion: #4517

@jiceatscion
Copy link
Contributor

This change is Reviewable

@tzaeschke
Copy link
Contributor Author

The build currently fails because the proposal is not in any TOC-tree. As I understand it, this is by design because, following index.rst, a proposal is only added to a TOC tree once the change proposal converges and a design document is approved.

Please let me know if the build problem should be fixed before proceeding.

@jiceatscion
Copy link
Contributor

I wonder if it could make sense to add a WIP section to the index and insert those proposals that are in active discussion. If only to avoid the rrt build failed noise. Thumbs up, thumbs down?

@matzf matzf added i/proposal A new idea requiring additional input and discussion design doc labels Jul 12, 2024
jiceatscion added a commit that referenced this pull request Jul 24, 2024
It is not possible to build without error in the presence of a document
that is not in the index. In order for CS not to fail for PRs that
include a new, not-yet-approved doc, adding an index section where they
can be safely linked.

See:
#4560 (comment)
@jiceatscion
Copy link
Contributor

You can now link your doc to the WIP section to get rid of the CI grumbling.

@tzaeschke tzaeschke changed the title NAT address discovery doc: proposal for nat address discovery Jul 26, 2024
Copy link
Contributor

@jiceatscion jiceatscion left a comment

Choose a reason for hiding this comment

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

Reviewed 1 of 1 files at r2, 1 of 1 files at r3, all commit messages.
Reviewable status: :shipit: complete! all files reviewed, all discussions resolved (waiting on @tzaeschke)

@tzaeschke
Copy link
Contributor Author

tzaeschke commented Sep 20, 2024

(waiting on @tzaeschke)

@jiceatscion I am unclear about the process. Can you tell me what I am meant to do?

@jiceatscion
Copy link
Contributor

jiceatscion commented Sep 20, 2024

I am a bit unclear about the process as well to be honest. Matthias had defined it very well on an abstract basis: Your design is in the final review state. The process says: "
Design:

If the proposal has been accepted, the authors submit a design document and submit it to the repository ([doc/dev/design](https://github.com/scionproto/scion/blob/26103217c8074dba85330905ee7d4fae4127fb6f/doc/dev/design)) in the form of a pull request. See [Design Documents](https://docs.scion.org/en/latest/dev/design/index.html) for details.

"

However it doesn't describe the mechanics after that. Should we use the PR as a vehicle for discussions and refinement? That would mean that the doc should never be submitted before the final approval. Not sure that would be the best. As long as the design is marked W-I-P submitting it would be OK, so more than one person can make changes to the design text.

Thoughts? Anyone?

@jiceatscion jiceatscion requested a review from a team September 20, 2024 12:06
@jiceatscion jiceatscion merged commit 557651e into scionproto:master Sep 23, 2024
5 checks passed
@tzaeschke tzaeschke mentioned this pull request Sep 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
design doc i/proposal A new idea requiring additional input and discussion
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants