Re: [edk2-devel] [PATCH tianocore-docs v3 2/2] Readme.md: Update the Gitbook documentation section

["Leif Lindholm" <quic_llindhol@quicinc.com>]

Hi Mike,

Have been thinking on this (and been on holiday last week).

On Thu, Apr 06, 2023 at 16:28:57 +0000, Michael D Kinney wrote:
> I am not sure.  The current contributors agreement has support for code and documentation.
>
> The specific sections on documents are:
> * https://github.com/tianocore-docs/edk2-BuildSpecification/blob/db69f5661caec977fac9730e21e5a1132f6ff80b/CONTRIBUTIONS.txt#L29
> * https://github.com/tianocore-docs/edk2-BuildSpecification/blob/db69f5661caec977fac9730e21e5a1132f6ff80b/CONTRIBUTIONS.txt#L60
> 
> There is an SPDX identifier for Free BSD Docs:
> * https://spdx.org/licenses/FreeBSD-DOC.html
> 
> What is not clear to me is if a COO indicated by Signed-off-by
> Combined with SPDX of FreeBSD-DOC is equivalent to the current
> contributors agreement or not.
> 
> Can you evaluate?

It's not *equivalent*, so the question is whether dropping it would be
problematic to anyone (be that practically, legally or politically).
- The TianoCore Contribution Agreement (TCA) explicitly grants rights
  to Intel, as opposed to the project, beyond what the FreeBSD license
  does.
- The FreeBSD Documentation License (FDL) as documented by SPDX
  explicitly references SGML (lol), whereas the license pointed to by
  the link now says AsciiDoc.
  - We could carry a copy of the licenseto disambiguate, but this is
    as much a problem today as it would be if we dropped the TCA.

My view of the individual sections of the TCA:
- Section 1 - definitions. Feels redundant to me.
- Section 2 - license.
  - Sneaks in a non-endorsement clause. Do we need that?
  - Adds an explixit patent grant. Do we need that for the
    *documentation* of software covered by an explicit patent grant?
  - Liability statement looks identical to BDL.
- Section 3 - Representations.
  - My view is the DCO(/COO) makes this section redundant.
- Section 4 - Third Party Contributions.
  - Feels conflicting/redundant with DCO, and less relevant for
    documentation?
- Section 5 - Miscellaneous.
  - Feels at best redundant and at worst not compatible with either
    FDL or DCO as applied to an open source project - feels yanked out
    of a proprietary license.

/
    Leif

> > -----Original Message-----
> > From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of Leif Lindholm
> > Sent: Thursday, April 6, 2023 2:47 AM
> > To: devel@edk2.groups.io
> > Cc: rebecca@bsdio.com; Ard Biesheuvel <ardb+tianocore@kernel.org>; Demeter, Miki <miki.demeter@intel.com>; Kinney, Michael
> > D <michael.d.kinney@intel.com>
> > Subject: Re: [edk2-devel] [PATCH tianocore-docs v3 2/2] Readme.md: Update the Gitbook documentation section
> > 
> > On Thu, Apr 06, 2023 at 10:42:34 +0100, Leif Lindholm wrote:
> > > On Wed, Apr 05, 2023 at 19:06:18 -0600, Rebecca Cran wrote:
> > > > We no longer use Gitbook for publishing the documentation.
> > > > Update the section to direct users to use the mailing list to
> > > > send feedback, and since we use GitHub Flavored Markdown, remove the
> > > > link to Gitbook.
> > > >
> > > > Contributed-under: TianoCore Contribution Agreement 1.1
> > >
> > > We don't use that any more, please drop (old template?).
> > 
> > Or, err, have we not fixed that for tianocore-docs?
> > This feels suboptimal.
> > 
> > Mike: is this something we can address?
> > 
> > /
> >     Leif
> > 
> > > With that:
> > > Reviewed-by: Leif Lindholm <quic_llindhol@quicinc.com>
> > >
> > > > Signed-off-by: Rebecca Cran <rebecca@bsdio.com>
> > > > ---
> > > >  Readme.md | 7 +++----
> > > >  1 file changed, 3 insertions(+), 4 deletions(-)
> > > >
> > > > diff --git a/Readme.md b/Readme.md
> > > > index 1e4a5d25bd6f..494b23af3ac7 100644
> > > > --- a/Readme.md
> > > > +++ b/Readme.md
> > > > @@ -30,12 +30,11 @@ documentation.
> > > >
> > > >  # EDK II GitBook Documents
> > > >
> > > > -These are the latest draft revisions published using [Gitbook](https://legacy.gitbook.com/).
> > > > +These are the latest draft revisions.
> > > >  The source content for these documents are in GIT repositories in the
> > > >  [Tianocore-docs](https://github.com/tianocore-docs) organization hosted by [GitHub](https://github.com).
> > > > -Feedback on these documents may be provided using the [Gitbook](https://www.gitbook.com) commenting feature
> > > > -available when reading the **HTML** versions of the documents. Document issues and feature requests can also
> > > > -be entered in [Tianocore Bugzilla](https://bugzilla.tianocore.org).
> > > > +Feedback on these documents may be provided via the mailing list.
> > > > +Document issues and feature requests can also be entered in [Tianocore Bugzilla](https://bugzilla.tianocore.org).
> > > >
> > > >  * **_EDK II Build Specification_** \[
> > > >  [HTML   ](https://tianocore-docs.github.io/edk2-BuildSpecification/draft/),
> > > > --
> > > > 2.39.2 (Apple Git-143)
> > > >
> > > >
> > > >
> > > >
> > > >
> > > >
> > >
> > >
> > >
> > >
> > >
> > 
> > 
> > 
> > 
> 
> 
> 
> 
> 
>