[PATCH tianocore-docs v3 0/2] Fix links to specifications, guides etc.

[PATCH tianocore-docs v3 0/2] Fix links to specifications, guides etc.

[Rebecca Cran]

We stopped using Gitbook for publishing documentation a
while ago, and now use GitHub Flavored Markdown
and publish pages to Github Pages at tianocore-docs.github.io.

Fix the links to the draft documentation pages,
and update the text to point users to the mailing list
since they can no longer provide feedback via
gitbook.com.

Changes from v1 to v3:

  Removed the link to gitbook.

Rebecca Cran (2):
  Readme.md: convert links from Gitbook to Github Pages
  Readme.md: Update the Gitbook documentation section

 Readme.md | 124 +++++++++-----------
 1 file changed, 55 insertions(+), 69 deletions(-)

-- 
2.39.2 (Apple Git-143)

[PATCH tianocore-docs v3 1/2] Readme.md: convert links from Gitbook to Github Pages

[Rebecca Cran]

We no longer publish documentation to gitbook.com, instead
using tianocore-docs.github.io. Update the links to point
to the correct locations.

Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Rebecca Cran <rebecca@bsdio.com>
Reviewed-by: Michael D Kinney <michael.d.kinney@intel.com>
---
 Readme.md | 117 +++++++++-----------
 1 file changed, 52 insertions(+), 65 deletions(-)

diff --git a/Readme.md b/Readme.md
index e6d35fa41131..1e4a5d25bd6f 100644
--- a/Readme.md
+++ b/Readme.md
@@ -38,121 +38,108 @@ available when reading the **HTML** versions of the documents. Document issues a
 be entered in [Tianocore Bugzilla](https://bugzilla.tianocore.org).
 
 * **_EDK II Build Specification_** \[
-[HTML   ](https://www.gitbook.com/read/book/edk2-docs/edk-ii-build-specification),
-[PDF    ](https://www.gitbook.com/download/pdf/book/edk2-docs/edk-ii-build-specification),
-[Mobi   ](https://www.gitbook.com/download/mobi/book/edk2-docs/edk-ii-build-specification),
-[ePub   ](https://www.gitbook.com/download/epub/book/edk2-docs/edk-ii-build-specification),
-[Gitbook](https://www.gitbook.com/book/edk2-docs/edk-ii-build-specification),
+[HTML   ](https://tianocore-docs.github.io/edk2-BuildSpecification/draft/),
+[PDF    ](https://tianocore-docs.github.io/edk2-BuildSpecification/draft/edk2-BuildSpecification-draft.pdf),
+[Mobi   ](https://tianocore-docs.github.io/edk2-BuildSpecification/draft/edk2-BuildSpecification-draft.mobi),
+[ePub   ](https://tianocore-docs.github.io/edk2-BuildSpecification/draft/edk2-BuildSpecification-draft.epub),
 [GitHub ](https://github.com/tianocore-docs/edk2-BuildSpecification)
 \]
 
 * **_EDK II DEC Specification_** \[
-[HTML   ](https://www.gitbook.com/read/book/edk2-docs/edk-ii-dec-specification),
-[PDF    ](https://www.gitbook.com/download/pdf/book/edk2-docs/edk-ii-dec-specification),
-[Mobi   ](https://www.gitbook.com/download/mobi/book/edk2-docs/edk-ii-dec-specification),
-[ePub   ](https://www.gitbook.com/download/epub/book/edk2-docs/edk-ii-dec-specification),
-[Gitbook](https://www.gitbook.com/book/edk2-docs/edk-ii-dec-specification),
+[HTML   ](https://tianocore-docs.github.io/edk2-DecSpecification/draft/),
+[PDF    ](https://tianocore-docs.github.io/edk2-DecSpecification/draft/edk2-DecSpecification-draft.pdf),
+[Mobi   ](https://tianocore-docs.github.io/edk2-DecSpecification/draft/edk2-DecSpecification-draft.mobi),
+[ePub   ](https://tianocore-docs.github.io/edk2-DecSpecification/draft/edk2-DecSpecification-draft.epub),
 [GitHub ](https://github.com/tianocore-docs/edk2-DecSpecification)
 \]
 
 * **_EDK II INF Specification_** \[
-[HTML   ](https://www.gitbook.com/read/book/edk2-docs/edk-ii-inf-specification),
-[PDF    ](https://www.gitbook.com/download/pdf/book/edk2-docs/edk-ii-inf-specification),
-[Mobi   ](https://www.gitbook.com/download/mobi/book/edk2-docs/edk-ii-inf-specification),
-[ePub   ](https://www.gitbook.com/download/epub/book/edk2-docs/edk-ii-inf-specification),
-[Gitbook](https://www.gitbook.com/book/edk2-docs/edk-ii-inf-specification),
+[HTML   ](https://tianocore-docs.github.io/edk2-InfSpecification/draft/),
+[PDF    ](https://tianocore-docs.github.io/edk2-InfSpecification/draft/edk2-InfSpecification-draft.pdf),
+[Mobi   ](https://tianocore-docs.github.io/edk2-InfSpecification/draft/edk2-InfSpecification-draft.mobi),
+[ePub   ](https://tianocore-docs.github.io/edk2-InfSpecification/draft/edk2-InfSpecification-draft.epub),
 [GitHub ](https://github.com/tianocore-docs/edk2-InfSpecification)
 \]
 
 * **_EDK II DSC Specification_** \[
-[HTML   ](https://www.gitbook.com/read/book/edk2-docs/edk-ii-dsc-specification),
-[PDF    ](https://www.gitbook.com/download/pdf/book/edk2-docs/edk-ii-dsc-specification),
-[Mobi   ](https://www.gitbook.com/download/mobi/book/edk2-docs/edk-ii-dsc-specification),
-[ePub   ](https://www.gitbook.com/download/epub/book/edk2-docs/edk-ii-dsc-specification),
-[Gitbook](https://www.gitbook.com/book/edk2-docs/edk-ii-dsc-specification/details),
+[HTML   ](https://tianocore-docs.github.io/edk2-DscSpecification/draft/),
+[PDF    ](https://tianocore-docs.github.io/edk2-DscSpecification/draft/edk2-DscSpecification-draft.pdf),
+[Mobi   ](https://tianocore-docs.github.io/edk2-DscSpecification/draft/edk2-DscSpecification-draft.mobi),
+[ePub   ](https://tianocore-docs.github.io/edk2-DscSpecification/draft/edk2-DscSpecification-draft.epub),
 [GitHub ](https://github.com/tianocore-docs/edk2-DscSpecification)
 \]
 
 * **_EDK II FDF Specification_** \[
-[HTML   ](https://www.gitbook.com/read/book/edk2-docs/edk-ii-fdf-specification),
-[PDF    ](https://www.gitbook.com/download/pdf/book/edk2-docs/edk-ii-fdf-specification),
-[Mobi   ](https://www.gitbook.com/download/mobi/book/edk2-docs/edk-ii-fdf-specification),
-[ePub   ](https://www.gitbook.com/download/epub/book/edk2-docs/edk-ii-fdf-specification),
-[Gitbook](https://www.gitbook.com/book/edk2-docs/edk-ii-fdf-specification),
+[HTML   ](https://tianocore-docs.github.io/edk2-FdfSpecification/draft/),
+[PDF    ](https://tianocore-docs.github.io/edk2-FdfSpecification/draft/edk2-FdfSpecification-draft.pdf),
+[Mobi   ](https://tianocore-docs.github.io/edk2-FdfSpecification/draft/edk2-FdfSpecification-draft.mobi),
+[ePub   ](https://tianocore-docs.github.io/edk2-FdfSpecification/draft/edk2-FdfSpecification-draft.epub),
 [GitHub ](https://github.com/tianocore-docs/edk2-FdfSpecification)
 \]
 
 * **_EDK II UNI Specification_** \[
-[HTML   ](https://www.gitbook.com/read/book/edk2-docs/edk-ii-uni-specification),
-[PDF    ](https://www.gitbook.com/download/pdf/book/edk2-docs/edk-ii-uni-specification),
-[Mobi   ](https://www.gitbook.com/download/mobi/book/edk2-docs/edk-ii-uni-specification),
-[ePub   ](https://www.gitbook.com/download/epub/book/edk2-docs/edk-ii-uni-specification),
-[Gitbook](https://www.gitbook.com/book/edk2-docs/edk-ii-uni-specification),
+[HTML   ](https://tianocore-docs.github.io/edk2-UniSpecification/draft/),
+[PDF    ](https://tianocore-docs.github.io/edk2-UniSpecification/draft/edk2-UniSpecification-draft.pdf),
+[Mobi   ](https://tianocore-docs.github.io/edk2-UniSpecification/draft/edk2-UniSpecification-draft.mobi),
+[ePub   ](https://tianocore-docs.github.io/edk2-UniSpecification/draft/edk2-UniSpecification-draft.epub),
 [GitHub ](https://github.com/tianocore-docs/edk2-UniSpecification)
 \]
 
 * **_EDK II Image Definition IDF File Format Specification_** \[
-[HTML   ](https://www.gitbook.com/read/book/edk2-docs/edk-ii-idf-specification),
-[PDF    ](https://www.gitbook.com/download/pdf/book/edk2-docs/edk-ii-idf-specification),
-[Mobi   ](https://www.gitbook.com/download/mobi/book/edk2-docs/edk-ii-idf-specification),
-[ePub   ](https://www.gitbook.com/download/epub/book/edk2-docs/edk-ii-idf-specification),
-[Gitbook](https://www.gitbook.com/book/edk2-docs/edk-ii-idf-specification),
+[HTML   ](https://tianocore-docs.github.io/edk2-IdfSpecification/draft/),
+[PDF    ](https://tianocore-docs.github.io/edk2-IdfSpecification/draft/edk2-IdfSpecification-draft.pdf),
+[Mobi   ](https://tianocore-docs.github.io/edk2-IdfSpecification/draft/edk2-IdfSpecification-draft.mobi),
+[ePub   ](https://tianocore-docs.github.io/edk2-IdfSpecification/draft/edk2-IdfSpecification-draft.epub),
 [GitHub ](https://github.com/tianocore-docs/edk2-IdfSpecification)
 \]
 
 * **_EDK II VFR Specification_** \[
-[HTML   ](https://www.gitbook.com/read/book/edk2-docs/edk-ii-vfr-specification),
-[PDF    ](https://www.gitbook.com/download/pdf/book/edk2-docs/edk-ii-vfr-specification),
-[Mobi   ](https://www.gitbook.com/download/mobi/book/edk2-docs/edk-ii-vfr-specification),
-[ePub   ](https://www.gitbook.com/download/epub/book/edk2-docs/edk-ii-vfr-specification),
-[Gitbook](https://www.gitbook.com/book/edk2-docs/edk-ii-vfr-specification),
+[HTML   ](https://tianocore-docs.github.io/edk2-VfrSpecification/draft/),
+[PDF    ](https://tianocore-docs.github.io/edk2-VfrSpecification/draft/edk2-VfrSpecification-draft.pdf),
+[Mobi   ](https://tianocore-docs.github.io/edk2-VfrSpecification/draft/edk2-VfrSpecification-draft.mobi),
+[ePub   ](https://tianocore-docs.github.io/edk2-VfrSpecification/draft/edk2-VfrSpecification-draft.epub),
 [GitHub ](https://github.com/tianocore-docs/edk2-VfrSpecification)
 \]
 
 * **_EDK II Meta-Data Expression Syntax Specification_** \[
-[HTML   ](https://www.gitbook.com/read/book/edk2-docs/edk-ii-meta-data-expression-syntax-specification),
-[PDF    ](https://www.gitbook.com/download/pdf/book/edk2-docs/edk-ii-meta-data-expression-syntax-specification),
-[Mobi   ](https://www.gitbook.com/download/mobi/book/edk2-docs/edk-ii-meta-data-expression-syntax-specification),
-[ePub   ](https://www.gitbook.com/download/epub/book/edk2-docs/edk-ii-meta-data-expression-syntax-specification),
-[Gitbook](https://www.gitbook.com/book/edk2-docs/edk-ii-meta-data-expression-syntax-specification),
+[HTML   ](https://tianocore-docs.github.io/edk2-MetaDataExpressionSyntaxSpecification/draft/),
+[PDF    ](https://tianocore-docs.github.io/edk2-MetaDataExpressionSyntaxSpecification/draft/edk2-MetaDataExpressionSyntaxSpecification-draft.pdf),
+[Mobi   ](https://tianocore-docs.github.io/edk2-MetaDataExpressionSyntaxSpecification/draft/edk2-MetaDataExpressionSyntaxSpecification-draft.mobi),
+[ePub   ](https://tianocore-docs.github.io/edk2-MetaDataExpressionSyntaxSpecification/draft/edk2-MetaDataExpressionSyntaxSpecification-draft.epub),
 [GitHub ](https://github.com/tianocore-docs/edk2-MetaDataExpressionSyntaxSpecification)
 \]
 
 * **_EDK II PCD Specification_** \[
-[HTML   ](https://www.gitbook.com/read/book/edk2-docs/edk-ii-pcd-specification),
-[PDF    ](https://www.gitbook.com/download/pdf/book/edk2-docs/edk-ii-pcd-specification),
-[Mobi   ](https://www.gitbook.com/download/mobi/book/edk2-docs/edk-ii-pcd-specification),
-[ePub   ](https://www.gitbook.com/download/epub/book/edk2-docs/edk-ii-pcd-specification),
-[Gitbook](https://www.gitbook.com/book/edk2-docs/edk-ii-pcd-specification),
+[HTML   ](https://tianocore-docs.github.io/edk2-PcdSpecification/draft/),
+[PDF    ](https://tianocore-docs.github.io/edk2-PcdSpecification/draft/edk2-PcdSpecification-draft.pdf),
+[Mobi   ](https://tianocore-docs.github.io/edk2-PcdSpecification/draft/edk2-PcdSpecification-draft.mobi),
+[ePub   ](https://tianocore-docs.github.io/edk2-PcdSpecification/draft/edk2-PcdSpecification-draft.epub),
 [GitHub ](https://github.com/tianocore-docs/edk2-PcdSpecification)
 \]
 
 * **_EDK II C Coding Standards Specification_** \[
-[HTML   ](https://www.gitbook.com/read/book/edk2-docs/edk-ii-c-coding-standards-specification),
-[PDF    ](https://www.gitbook.com/download/pdf/book/edk2-docs/edk-ii-c-coding-standards-specification),
-[Mobi   ](https://www.gitbook.com/download/mobi/book/edk2-docs/edk-ii-c-coding-standards-specification),
-[ePub   ](https://www.gitbook.com/download/epub/book/edk2-docs/edk-ii-c-coding-standards-specification),
-[Gitbook](https://www.gitbook.com/book/edk2-docs/edk-ii-c-coding-standards-specification),
+[HTML   ](https://tianocore-docs.github.io/edk2-CCodingStandardsSpecification/draft/),
+[PDF    ](https://tianocore-docs.github.io/edk2-CCodingStandardsSpecification/draft/edk2-CCodingStandardsSpecification-draft.pdf),
+[Mobi   ](https://tianocore-docs.github.io/edk2-CCodingStandardsSpecification/draft/edk2-CCodingStandardsSpecification-draft.mobi),
+[ePub   ](https://tianocore-docs.github.io/edk2-CCodingStandardsSpecification/draft/edk2-CCodingStandardsSpecification-draft.epub),
 [GitHub ](https://github.com/tianocore-docs/edk2-CCodingStandardsSpecification)
 \]
 
 * **_EDK II Driver Writer's Guide for UEFI 2.3.1_** \[
-[HTML   ](https://edk2-docs.gitbooks.io/edk-ii-uefi-driver-writer-s-guide/content),
-[PDF    ](https://legacy.gitbook.com/download/pdf/book/edk2-docs/edk-ii-uefi-driver-writer-s-guide),
-[Mobi   ](https://legacy.gitbook.com/download/mobi/book/edk2-docs/edk-ii-uefi-driver-writer-s-guide),
-[ePub   ](https://legacy.gitbook.com/download/epub/book/edk2-docs/edk-ii-uefi-driver-writer-s-guide),
-[Gitbook](https://legacy.gitbook.com/book/edk2-docs/edk-ii-uefi-driver-writer-s-guide),
+[HTML   ](https://tianocore-docs.github.io/edk2-UefiDriverWritersGuide/draft/),
+[PDF    ](https://tianocore-docs.github.io/edk2-UefiDriverWritersGuide/draft/edk2-UefiDriverWritersGuide-draft.pdf),
+[Mobi   ](https://tianocore-docs.github.io/edk2-UefiDriverWritersGuide/draft/edk2-UefiDriverWritersGuide-draft.mobi),
+[ePub   ](https://tianocore-docs.github.io/edk2-UefiDriverWritersGuide/draft/edk2-UefiDriverWritersGuide-draft.epub),
 [GitHub ](https://github.com/tianocore-docs/edk2-UefiDriverWritersGuide)
 \]
 
 ---
 
 * **_EDK II Template Specification_** \[
-[HTML   ](https://www.gitbook.com/read/book/edk2-docs/edk-ii-template-specification),
-[PDF    ](https://www.gitbook.com/download/pdf/book/edk2-docs/edk-ii-template-specification),
-[Mobi   ](https://www.gitbook.com/download/mobi/book/edk2-docs/edk-ii-template-specification),
-[ePub   ](https://www.gitbook.com/download/epub/book/edk2-docs/edk-ii-template-specification),
-[Gitbook](https://www.gitbook.com/book/edk2-docs/edk-ii-template-specification),
+[HTML   ](https://tianocore-docs.github.io/edk2-TemplateSpecification/draft/),
+[PDF    ](https://tianocore-docs.github.io/edk2-TemplateSpecification/draft/edk2-TemplateSpecification-draft.pdf),
+[Mobi   ](https://tianocore-docs.github.io/edk2-TemplateSpecification/draft/edk2-TemplateSpecification-draft.mobi),
+[ePub   ](https://tianocore-docs.github.io/edk2-TemplateSpecification/draft/edk2-TemplateSpecification-draft.epub),
 [GitHub ](https://github.com/tianocore-docs/edk2-TemplateSpecification)
 \]
 
-- 
2.39.2 (Apple Git-143)

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

[Rebecca Cran]

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
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)

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

[Michael D Kinney]

Reviewed-by: Michael D Kinney <michael.d.kinney@intel.com>



> -----Original Message-----
> From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of Rebecca Cran
> Sent: Wednesday, April 5, 2023 6:06 PM
> To: devel@edk2.groups.io; Ard Biesheuvel <ardb+tianocore@kernel.org>; Demeter, Miki <miki.demeter@intel.com>; Kinney,
> Michael D <michael.d.kinney@intel.com>; Leif Lindholm <quic_llindhol@quicinc.com>
> Cc: Rebecca Cran <rebecca@bsdio.com>
> Subject: [edk2-devel] [PATCH tianocore-docs v3 2/2] Readme.md: Update the Gitbook documentation section
> 
> 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
> 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)
> 
> 
> 
> 
> 

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

[Leif Lindholm]

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?).

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)
> 
> 
> 
> 
> 
> 

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

[Leif Lindholm]

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)
> > 
> > 
> > 
> > 
> > 
> > 
> 
> 
> 
> 
> 

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

[Rebecca Cran]

On 4/6/23 3:47 AM, Leif Lindholm wrote:

> 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?

I talked to Mike about this at the TianoCore Community Meeting a few 
minutes ago, and our understanding is that the TianoCore Contribution 
Agreement is still required for documentation.

If we want to drop it, it sounds like we'd need to figure out how to do 
so for the docs.


-- 
Rebecca Cran

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

[Michael D Kinney]

Hi Leif,

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?

Mike

> -----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)
> > >
> > >
> > >
> > >
> > >
> > >
> >
> >
> >
> >
> >
> 
> 
> 
> 

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

[Leif Lindholm]

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)
> > > >
> > > >
> > > >
> > > >
> > > >
> > > >
> > >
> > >
> > >
> > >
> > >
> > 
> > 
> > 
> > 
> 
> 
> 
> 
> 
> 

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

[Michael D Kinney]

Hi Leif,

Thank you for the analysis.  I am evaluating a few options.  If I come up with
a reasonable proposal, I will send an RFC.

Mike

> -----Original Message-----
> From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of Leif Lindholm
> Sent: Monday, April 17, 2023 5:19 AM
> To: devel@edk2.groups.io; Kinney, Michael D <michael.d.kinney@intel.com>
> Cc: rebecca@bsdio.com; Ard Biesheuvel <ardb+tianocore@kernel.org>; Demeter, Miki <miki.demeter@intel.com>
> Subject: Re: [edk2-devel] [PATCH tianocore-docs v3 2/2] Readme.md: Update the Gitbook documentation section
> 
> 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)
> > > > >
> > > > >
> > > > >
> > > > >
> > > > >
> > > > >
> > > >
> > > >
> > > >
> > > >
> > > >
> > >
> > >
> > >
> > >
> >
> >
> >
> >
> >
> >
> 
> 
> 
>