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

nixos docs: add release manager section #31064

Merged
merged 1 commit into from Aug 24, 2019

Conversation

disassembler
Copy link
Member

Motivation for this change

This documents the process of electing and roles and responsibilities of the release management team per https://github.com/NixOS/rfcs/blob/master/rfcs/0015-release-manager.md.

@vcunat
Copy link
Member

vcunat commented Oct 31, 2017

I wonder how to handle RFCs. There should certainly be a link to the RFC, and if we have that, it might be better to reduce the duplicate content to just a sentence or two (but I'm not sure). I actually don't even see any information whether changing RFCs will be done in-place (seems preferred, as we have version control) or by issuing replacements under new numbers (like IETF RFCs).

A release manager's role and responsibilities are:
</para>
<itemizedlist>
<listitem><para>manage the release process</para></listitem>
Copy link
Member

@Ma27 Ma27 Nov 1, 2017

Choose a reason for hiding this comment

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

I'm not a native speaker, but a [...] manager [...] manages is an awkward expression, right?
Instead I'd just suggest to "steal" the bullet points about responsibilities from @fpletz's slides (if he's fine with it :p): https://youtu.be/fdj9tzRaLn4?list=PLgknCdxP89ReQzhfKwMYjLdwWsc7us8ns&t=188 as they were a good summary :-)

@globin
Copy link
Member

globin commented Nov 1, 2017

cc @zimbatm, @grahamc, @teh, @moretea, @peti, @edolstra, @domenkozar, @FRidh on how to handle the RFCs => documenting them in the manual, amending rfcs in the repo or writing new rfcs that obsolete old ones?

@grahamc
Copy link
Member

grahamc commented Nov 1, 2017 via email

@vcunat
Copy link
Member

vcunat commented Nov 1, 2017

Immutability: perhaps it would be best to make them explicitly versioned, e.g. RFC 15.1 or something. My experience with IETF RFCs is that all those different numbers are hard to remember, so I'd prefer to minimize their amount, say that "15.x" will describe our release managers forever...

@zimbatm
Copy link
Member

zimbatm commented Nov 1, 2017

I see RFCs mainly as a communication tool that helps us reach consensus on bigger items. Once a RFC has been merged it means that we agree on the direction and the implementation should happen elsewhere. I don't think that the RFC should be mutated afterwards, except to correct metadata (to add the forward-reference to the implementation PR).

What it means in practice is that usually the body of the proposal contains useful information that would get duplicated elsewhere and keep evolving in the repo where the actual work is happening. In that regard the RFC would only be useful as a reference shortly after the RFC has been accepted.

Back-references to the RFC aren't really necessary. I would probably only reference it in the implementation PR to help reviewers understand the context but that's it.

@moretea
Copy link
Contributor

moretea commented Nov 1, 2017

If the work to implement an accepted RFC involves documentation, then that should be added to the relevant manual. The RFC's themselves are just to achieve consensus in the community on what to do exactly without starting the work itself.

IMHO, if a new RFC obsoletes (part of) an existing RFC, the PR for the new one should add some note to the top of the existing one to make sure that readers are aware that some parts are outdated.

@vcunat
Copy link
Member

vcunat commented Nov 1, 2017

If the RFCs are/were just temporary things to discuss about and achieve consensus, I don't much understand why a formal-like document is actually created in the process.

EDIT: my perception might have been biased by having studied lots of IETF RFCs.

@zimbatm
Copy link
Member

zimbatm commented Nov 1, 2017

The RFC term is a bit too overloaded so it might create some confusion. The format is useful to force the discussion in a productive way. It encourages a proper problem statement, proposed implementation and ensures that research has been done. With that in hand, the reader would then ideally have enough context to form his own opinion. Otherwise we have the issue where things are being discusses in a bunch of places and not everybody has read the same things so we haven't all explored the same branches of the decision tree.

@samueldr
Copy link
Member

Anything preventing this to be added to the manual? Other than the merge conflict

Copy link
Member

@grahamc grahamc left a comment

Choose a reason for hiding this comment

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

+1 after the section is no longer nested in the schedule.

@mmahut
Copy link
Member

mmahut commented Aug 10, 2019

Are there any updates on this pull request, please?

@disassembler disassembler force-pushed the release-manager-docs branch 2 times, most recently from d1d2dd1 to 88f69bf Compare August 23, 2019 14:07
@disassembler disassembler merged commit 5f06052 into NixOS:master Aug 24, 2019
@disassembler disassembler deleted the release-manager-docs branch August 24, 2019 13:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet