draft-ietf-git-github-wg-configuration-02.txt		draft-ietf-git-github-wg-configuration-03.txt
	GIT Working Group A. Cooper		GIT Working Group A. Cooper
	Internet-Draft Cisco		Internet-Draft Cisco
	Intended status: Informational P. Hoffman		Intended status: Informational P. Hoffman
	Expires: March 10, 2020 ICANN		Expires: April 23, 2020 ICANN
	September 07, 2019		October 21, 2019
	GitHub Configuration for IETF Working Groups		GitHub Configuration for IETF Working Groups
	draft-ietf-git-github-wg-configuration-02		draft-ietf-git-github-wg-configuration-03
	Abstract		Abstract
	The use of GitHub in IETF working group processes is increasing.		The use of GitHub in IETF working group processes is increasing.
	This document describes possible uses and conventions for working		This document describes possible uses and conventions for working
	groups which are considering starting to use GitHub. It does not		groups which are considering starting to use GitHub. It does not
	mandate any processes, and does not require changes to the processes		mandate any processes, and does not require changes to the processes
	used by current and future working groups not using GitHub.		used by current and future working groups not using GitHub.
	Discussion of this document takes place on the ietf-and-github		Discussion of this document takes place on the ietf-and-github
	skipping to change at page 1, line 40 ¶		skipping to change at page 1, line 40 ¶
	Internet-Drafts are working documents of the Internet Engineering		Internet-Drafts are working documents of the Internet Engineering
	Task Force (IETF). Note that other groups may also distribute		Task Force (IETF). Note that other groups may also distribute
	working documents as Internet-Drafts. The list of current Internet-		working documents as Internet-Drafts. The list of current Internet-
	Drafts is at https://datatracker.ietf.org/drafts/current/.		Drafts is at https://datatracker.ietf.org/drafts/current/.
	Internet-Drafts are draft documents valid for a maximum of six months		Internet-Drafts are draft documents valid for a maximum of six months
	and may be updated, replaced, or obsoleted by other documents at any		and may be updated, replaced, or obsoleted by other documents at any
	time. It is inappropriate to use Internet-Drafts as reference		time. It is inappropriate to use Internet-Drafts as reference
	material or to cite them other than as "work in progress."		material or to cite them other than as "work in progress."
	This Internet-Draft will expire on March 10, 2020.		This Internet-Draft will expire on April 23, 2020.
	Copyright Notice		Copyright Notice
	Copyright (c) 2019 IETF Trust and the persons identified as the		Copyright (c) 2019 IETF Trust and the persons identified as the
	document authors. All rights reserved.		document authors. All rights reserved.
	This document is subject to BCP 78 and the IETF Trust's Legal		This document is subject to BCP 78 and the IETF Trust's Legal
	Provisions Relating to IETF Documents		Provisions Relating to IETF Documents
	(https://trustee.ietf.org/license-info) in effect on the date of		(https://trustee.ietf.org/license-info) in effect on the date of
	publication of this document. Please review these documents		publication of this document. Please review these documents
	skipping to change at page 2, line 22 ¶		skipping to change at page 2, line 22 ¶
	1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2		1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
	2. Administrative Process and Conventions . . . . . . . . . . . 3		2. Administrative Process and Conventions . . . . . . . . . . . 3
	2.1. Creation of GitHub Organizations . . . . . . . . . . . . 3		2.1. Creation of GitHub Organizations . . . . . . . . . . . . 3
	2.2. Migration of an Existing Organization . . . . . . . . . . 4		2.2. Migration of an Existing Organization . . . . . . . . . . 4
	2.3. Personnel Changes . . . . . . . . . . . . . . . . . . . . 4		2.3. Personnel Changes . . . . . . . . . . . . . . . . . . . . 4
	2.4. Working Group Closing . . . . . . . . . . . . . . . . . . 4		2.4. Working Group Closing . . . . . . . . . . . . . . . . . . 4
	2.5. Creation of Document Repository . . . . . . . . . . . . . 4		2.5. Creation of Document Repository . . . . . . . . . . . . . 4
	3. Working Group Process . . . . . . . . . . . . . . . . . . . . 5		3. Working Group Process . . . . . . . . . . . . . . . . . . . . 5
	3.1. Contributions . . . . . . . . . . . . . . . . . . . . . . 5		3.1. Contributions . . . . . . . . . . . . . . . . . . . . . . 5
	3.2. Backing Up and Archiving GitHub Content . . . . . . . . . 5		3.2. Backing Up and Archiving GitHub Content . . . . . . . . . 6
	4. Security Considerations . . . . . . . . . . . . . . . . . . . 6		4. Security Considerations . . . . . . . . . . . . . . . . . . . 6
	5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 6		5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 6
	6. References . . . . . . . . . . . . . . . . . . . . . . . . . 6		6. References . . . . . . . . . . . . . . . . . . . . . . . . . 6
	6.1. Normative References . . . . . . . . . . . . . . . . . . 6		6.1. Normative References . . . . . . . . . . . . . . . . . . 6
	6.2. Informative References . . . . . . . . . . . . . . . . . 6		6.2. Informative References . . . . . . . . . . . . . . . . . 6
	Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 7		Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 7
	1. Introduction		1. Introduction
	Many IETF working groups and participants make use of GitHub in		Many IETF working groups and participants make use of GitHub in
	skipping to change at page 5, line 18 ¶		skipping to change at page 5, line 18 ¶
	o Migrating an existing document repository into the WG organization		o Migrating an existing document repository into the WG organization
	o Creating a new repository that contains multiple drafts		o Creating a new repository that contains multiple drafts
	As an incremental step, this document proposes that there be a		As an incremental step, this document proposes that there be a
	facility in the Datatracker interface to allow an administrator of an		facility in the Datatracker interface to allow an administrator of an
	ietf-<wgname>-wg organization to request the creation of a new		ietf-<wgname>-wg organization to request the creation of a new
	repository within that organization for a single document. The		repository within that organization for a single document. The
	document authors would be identified as collaborators. The		document authors would be identified as collaborators. The
	repository name would be the draft name. Ideally, the repository		repository name would be the draft name. Ideally, the repository
	would be configured with an skeleton draft file, default		would be configured with a skeleton draft file, default CONTRIBUTING,
	CONTRIBUTING, LICENSE, and README files, and continuous integration		LICENSE, and README files, and continuous integration support, in the
	support, in the vein of <https://github.com/martinthomson/		vein of <https://github.com/martinthomson/i-d-template>.
	i-d-template>.
	3. Working Group Process		3. Working Group Process
	[I-D.thomson-github-bcp] contains discussion of the different		[I-D.thomson-github-bcp] contains discussion of the different
	possible ways that a working group can use GitHub and the large		possible ways that a working group can use GitHub and the large
	number of decisions associated with doing so. This section proposes		number of decisions associated with doing so. This section proposes
	a basic set of administrative policies for working groups to follow		a basic set of administrative policies for working groups to follow
	and the administrative support needed to carry out those policies.		and the administrative support needed to carry out those policies.
	3.1. Contributions		3.1. Contributions
	skipping to change at page 5, line 45 ¶		skipping to change at page 5, line 44 ¶
	boilerplate text at <https://trustee.ietf.org/license-for-open-		boilerplate text at <https://trustee.ietf.org/license-for-open-
	source-repositories.html> from the IETF license file for open source		source-repositories.html> from the IETF license file for open source
	repositories. The CONTRIBUTING file can contain other information as		repositories. The CONTRIBUTING file can contain other information as
	well (see <https://github.com/ietf/repo-files/tree/master/		well (see <https://github.com/ietf/repo-files/tree/master/
	contributing-samples> for examples).		contributing-samples> for examples).
	It would be useful if the user data in the Datatracker could list (at		It would be useful if the user data in the Datatracker could list (at
	a minimum) the GitHub account of the user so that their contributions		a minimum) the GitHub account of the user so that their contributions
	could be tracked more easily.		could be tracked more easily.
			Some working groups choose to have more than one draft in a
			repository, particularly for drafts that are tightly linked with
			significant cross-references. In such a case, the README for the
			repository needs to say that clearly so that a participant
			understands that changes might be made to multiple drafts at once.
	3.2. Backing Up and Archiving GitHub Content		3.2. Backing Up and Archiving GitHub Content
	IETF working group mailing lists are automatically backed up by the		IETF working group mailing lists are automatically backed up by the
	IETF Secretariat, and the archives are publicly available. All		IETF Secretariat, and the archives are publicly available. All
	official interactions in a WG must be archived.		official interactions in a WG must be archived.
	It would be good for working group GitHub content to also be backed		It would be good for working group GitHub content to also be backed
	up and publicly archived. This document proposes using the git		up and publicly archived. This document proposes using the git
	protocol [git-protocol] itself for both of these tasks.		protocol [git-protocol] itself for both of these tasks.
	Every IETF working group repository on GitHub will have a mirror		Every IETF working group repository on GitHub will have a mirror
	repository of the same name on a server maintained by the IETF		repository of the same name on a server maintained by the IETF
	Secretariat. Every hour, a service will use the "git fetch" command		Secretariat. Every hour, a service will use the "git fetch" command
	on every GitHub repository that is being tracked. The mirror		on every GitHub repository that is being tracked. The mirror
	repository will allow anyone to read the repository.		repository will allow anyone to read the repository.
	Note that this system will not back up GitHub issues or pull		Note that this system will not back up GitHub issues or pull
	requests. It is very likely that these should be backed up as well.		requests. These should be backed up as well; the GitHub API allows
	The GitHub API possibly allows this; if so, the IETF Secretariat		for this. The IETF Secretariat should back up those at the same time
	should back up those at the same time as it is backing up the GitHub		as it is backing up the GitHub repositories.
	repositories.
	[I-D.thomson-github-bcp] has more discussion of backing up and
	archiving.
	4. Security Considerations		4. Security Considerations
	An attacker who can change the contents of Internet Drafts,		An attacker who can change the contents of Internet Drafts,
	particularly late in a working group's process, can possibly cause		particularly late in a working group's process, can possibly cause
	unnoticed changes in protocols that are eventually adopted.		unnoticed changes in protocols that are eventually adopted.
	5. IANA Considerations		5. IANA Considerations
	This document has no IANA actions.		This document has no IANA actions.
End of changes. 7 change blocks.
	16 lines changed or deleted		17 lines changed or added
This html diff was produced by rfcdiff 1.47. The latest version is available from http://tools.ietf.org/tools/rfcdiff/