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

Michael D Kinney michael.d.kinney at intel.com
Tue Mar 14 20:19:24 UTC 2023



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



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#101178): https://edk2.groups.io/g/devel/message/101178
Mute This Topic: https://groups.io/mt/97612887/1813853
Group Owner: devel+owner at edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/leave/3943202/1813853/130120423/xyzzy [edk2-devel-archive at redhat.com]
-=-=-=-=-=-=-=-=-=-=-=-




More information about the edk2-devel-archive mailing list