public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
* [PATCH tianocore-docs 0/2] Fix links to specifications, guides etc.
@ 2023-03-14 20:04 Rebecca Cran
  2023-03-14 20:04 ` [PATCH tianocore-docs 1/2] Readme.md: convert links from Gitbook to Github Pages Rebecca Cran
  2023-03-14 20:04 ` [PATCH tianocore-docs 2/2] Readme.md: Update the Gitbook documentation section Rebecca Cran
  0 siblings, 2 replies; 5+ messages in thread
From: Rebecca Cran @ 2023-03-14 20:04 UTC (permalink / raw)
  To: devel, Ard Biesheuvel, Bob Feng, Abner Chang, Jordan Justen,
	Liming Gao, Leif Lindholm, Michael Kubacki, Michael D Kinney,
	Miki Demeter, Ray Ni, Vincent Zimmer, Eric Dong
  Cc: Rebecca Cran

We stopped using Gitbook for publishing documentation a
while ago, and now only use the Gitbook markdown _format_
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.

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.37.1 (Apple Git-137.1)


^ permalink raw reply	[flat|nested] 5+ messages in thread

* [PATCH tianocore-docs 1/2] Readme.md: convert links from Gitbook to Github Pages
  2023-03-14 20:04 [PATCH tianocore-docs 0/2] Fix links to specifications, guides etc Rebecca Cran
@ 2023-03-14 20:04 ` Rebecca Cran
  2023-03-14 20:20   ` Michael D Kinney
  2023-03-14 20:04 ` [PATCH tianocore-docs 2/2] Readme.md: Update the Gitbook documentation section Rebecca Cran
  1 sibling, 1 reply; 5+ messages in thread
From: Rebecca Cran @ 2023-03-14 20:04 UTC (permalink / raw)
  To: devel, Ard Biesheuvel, Bob Feng, Abner Chang, Jordan Justen,
	Liming Gao, Leif Lindholm, Michael Kubacki, Michael D Kinney,
	Miki Demeter, Ray Ni, Vincent Zimmer, Eric Dong
  Cc: 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>
---
 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.37.1 (Apple Git-137.1)


^ permalink raw reply related	[flat|nested] 5+ messages in thread

* [PATCH tianocore-docs 2/2] Readme.md: Update the Gitbook documentation section
  2023-03-14 20:04 [PATCH tianocore-docs 0/2] Fix links to specifications, guides etc Rebecca Cran
  2023-03-14 20:04 ` [PATCH tianocore-docs 1/2] Readme.md: convert links from Gitbook to Github Pages Rebecca Cran
@ 2023-03-14 20:04 ` Rebecca Cran
  2023-03-14 20:19   ` Michael D Kinney
  1 sibling, 1 reply; 5+ messages in thread
From: Rebecca Cran @ 2023-03-14 20:04 UTC (permalink / raw)
  To: devel, Ard Biesheuvel, Bob Feng, Abner Chang, Jordan Justen,
	Liming Gao, Leif Lindholm, Michael Kubacki, Michael D Kinney,
	Miki Demeter, Ray Ni, Vincent Zimmer, Eric Dong
  Cc: 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 fix the Gitbook URL to point to the documentation
which includes how to format the documents.

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..7f0c05710c78 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 published using [Gitbook](https://docs.gitbook.com/).
 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.37.1 (Apple Git-137.1)


^ permalink raw reply related	[flat|nested] 5+ messages in thread

* Re: [PATCH tianocore-docs 2/2] Readme.md: Update the Gitbook documentation section
  2023-03-14 20:04 ` [PATCH tianocore-docs 2/2] Readme.md: Update the Gitbook documentation section Rebecca Cran
@ 2023-03-14 20:19   ` Michael D Kinney
  0 siblings, 0 replies; 5+ messages in thread
From: Michael D Kinney @ 2023-03-14 20:19 UTC (permalink / raw)
  To: Rebecca Cran, devel@edk2.groups.io, Ard Biesheuvel, Feng, Bob C,
	Abner Chang, Justen, Jordan L, Gao, Liming, Leif Lindholm,
	Michael Kubacki, Demeter, Miki, Ni, Ray, Zimmer, Vincent,
	Dong, Eric
  Cc: Kinney, Michael D



> -----Original Message-----
> From: Rebecca Cran <rebecca@bsdio.com>
> Sent: Tuesday, March 14, 2023 1:05 PM
> To: devel@edk2.groups.io; Ard Biesheuvel <ardb+tianocore@kernel.org>; Feng, Bob C <bob.c.feng@intel.com>; Abner
> Chang <abner.chang@amd.com>; Justen, Jordan L <jordan.l.justen@intel.com>; Gao, Liming <gaoliming@byosoft.com.cn>;
> Leif Lindholm <quic_llindhol@quicinc.com>; Michael Kubacki <mikuback@linux.microsoft.com>; Kinney, Michael D
> <michael.d.kinney@intel.com>; Demeter, Miki <miki.demeter@intel.com>; Ni, Ray <ray.ni@intel.com>; Zimmer, Vincent
> <vincent.zimmer@intel.com>; Dong, Eric <eric.dong@intel.com>
> Cc: Rebecca Cran <rebecca@bsdio.com>
> Subject: [PATCH tianocore-docs 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 fix the Gitbook URL to point to the documentation
> which includes how to format the documents.
> 
> 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..7f0c05710c78 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 published using [Gitbook](https://docs.gitbook.com/).

I don't think we should reference docs.gitbook.com.  The source format of the documents are
Gitbook Markdown and the tools used to generate the published docs are based on the open 
Source gitbook tools using a GitHub action and are published in repositories in the 
GitHub tianococore-docs organization.

>  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.37.1 (Apple Git-137.1)


^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH tianocore-docs 1/2] Readme.md: convert links from Gitbook to Github Pages
  2023-03-14 20:04 ` [PATCH tianocore-docs 1/2] Readme.md: convert links from Gitbook to Github Pages Rebecca Cran
@ 2023-03-14 20:20   ` Michael D Kinney
  0 siblings, 0 replies; 5+ messages in thread
From: Michael D Kinney @ 2023-03-14 20:20 UTC (permalink / raw)
  To: Rebecca Cran, devel@edk2.groups.io, Ard Biesheuvel, Feng, Bob C,
	Abner Chang, Justen, Jordan L, Gao, Liming, Leif Lindholm,
	Michael Kubacki, Demeter, Miki, Ni, Ray, Zimmer, Vincent,
	Dong, Eric
  Cc: Kinney, Michael D

Reviewed-by: Michael D Kinney <michael.d.kinneyintel.com>


> -----Original Message-----
> From: Rebecca Cran <rebecca@bsdio.com>
> Sent: Tuesday, March 14, 2023 1:05 PM
> To: devel@edk2.groups.io; Ard Biesheuvel <ardb+tianocore@kernel.org>; Feng, Bob C <bob.c.feng@intel.com>; Abner
> Chang <abner.chang@amd.com>; Justen, Jordan L <jordan.l.justen@intel.com>; Gao, Liming <gaoliming@byosoft.com.cn>;
> Leif Lindholm <quic_llindhol@quicinc.com>; Michael Kubacki <mikuback@linux.microsoft.com>; Kinney, Michael D
> <michael.d.kinney@intel.com>; Demeter, Miki <miki.demeter@intel.com>; Ni, Ray <ray.ni@intel.com>; Zimmer, Vincent
> <vincent.zimmer@intel.com>; Dong, Eric <eric.dong@intel.com>
> Cc: Rebecca Cran <rebecca@bsdio.com>
> Subject: [PATCH tianocore-docs 1/2] Readme.md: convert links from Gitbook to Github Pages
> 
> 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>
> ---
>  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.37.1 (Apple Git-137.1)


^ permalink raw reply	[flat|nested] 5+ messages in thread

end of thread, other threads:[~2023-03-14 20:20 UTC | newest]

Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2023-03-14 20:04 [PATCH tianocore-docs 0/2] Fix links to specifications, guides etc Rebecca Cran
2023-03-14 20:04 ` [PATCH tianocore-docs 1/2] Readme.md: convert links from Gitbook to Github Pages Rebecca Cran
2023-03-14 20:20   ` Michael D Kinney
2023-03-14 20:04 ` [PATCH tianocore-docs 2/2] Readme.md: Update the Gitbook documentation section Rebecca Cran
2023-03-14 20:19   ` Michael D Kinney

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox