From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from us-smtp-1.mimecast.com (us-smtp-1.mimecast.com [207.211.31.120]) by mx.groups.io with SMTP id smtpd.web11.6713.1587738799262119966 for ; Fri, 24 Apr 2020 07:33:19 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@redhat.com header.s=mimecast20190719 header.b=PGgtjbxN; spf=pass (domain: redhat.com, ip: 207.211.31.120, mailfrom: lersek@redhat.com) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1587738798; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=sD87FNzVnqo8SynA6w6xtFozq8b2D9ZfBwH5xMjBvPI=; b=PGgtjbxN4CciFSdvzfJ2DD28wVa2DTK2LWBbH9NHAKPQ7JW9cas+jmDHdsUc19EBZqgmng wd+1bDPFI0iJDDbxZIQq64rJZ/+TnQsca2kCTvTUyUplV4rh48rOhuABOxprwpobNqD+5V RWW5kvWTlBMDvVy4+v9GTWRQ1KhTzvI= Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-207-tm2JALemPNeSnYzpO9TTOw-1; Fri, 24 Apr 2020 10:33:16 -0400 X-MC-Unique: tm2JALemPNeSnYzpO9TTOw-1 Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.phx2.redhat.com [10.5.11.15]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 418FF1937FF1; Fri, 24 Apr 2020 14:33:14 +0000 (UTC) Received: from lacos-laptop-7.usersys.redhat.com (ovpn-113-159.ams2.redhat.com [10.36.113.159]) by smtp.corp.redhat.com (Postfix) with ESMTP id E81045D70C; Fri, 24 Apr 2020 14:33:11 +0000 (UTC) Subject: Re: [EXTERNAL] Re: [PATCH v2 0/6] Edk2 Platform and Core CI for ArmVirtPkg, EmulatorPkg, and OvmfPkg To: Sean Brogan , "michael.kubacki@outlook.com" , "devel@edk2.groups.io" Cc: Andrew Fish , Ard Biesheuvel , Bret Barkelew , Jordan Justen , Leif Lindholm , Liming Gao , "Kinney, Michael D" , Ray Ni References: <5fcd80ac-03d1-a806-6a69-4602bc0d352c@redhat.com> From: "Laszlo Ersek" Message-ID: Date: Fri, 24 Apr 2020 16:33:11 +0200 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:52.0) Gecko/20100101 Thunderbird/52.9.1 MIME-Version: 1.0 In-Reply-To: X-Scanned-By: MIMEDefang 2.79 on 10.5.11.15 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Language: en-US Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 7bit On 04/23/20 02:45, Sean Brogan wrote: > I was hoping that because it wasn't "HTML tag soup" that build status could be front and center in the package readme as I find that more in line with expectations on github based projects. Nesting it deeper in the package just means less people find it when looking at your package. But I could see a few ways to solve it so I am looking for feedback and alignment before doing anything else. > > Option 1. > > 1. Add the Platform CI build status for the three platforms to the Edk2 repo readme since these are platforms in edk2 this makes sense and brings the most visibility to their status and the existence of the builds. > 2. Convert edk2 repo readme to RST so it avoids "HTML tag soup" > 3. Move the remaining part of the OvmfPkg/Readme.rst file into OvmfPkg/PlatformCI/Readme.md (I prefer MD when not doing large tables of links as it is easier to write and slightly easier to read as plain text). > 4. Do step 3 for ArmVirtPkg and EmulatorPkg too > > Option 2. > 1. Leave the ReadMe.rst at the root of each package but only include the build status table and add a link to the PlatformCi/ReadMe.md > 2. Move the Pytool and Platform CI focused readme contents to PlatformCI/ReadMe.md > > Option 3. > > Something else. > > Finally does anyone have a strong preference for ReadMe vs README vs readme vs Readme vs ReAdMe? I see a mix of these in the edk2 code tree. Sorry, I didn't mean to ignore this sub-thread, I just got to see the other email (about the V10 branch) first. My understanding is that V10 has come to a resolution about the questions above; and I'm happy with V10 (as I stated in that thread). Thanks! Laszlo