public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
From: "Michael D Kinney" <michael.d.kinney@intel.com>
To: Rebecca Cran <rebecca@bsdio.com>,
	"devel@edk2.groups.io" <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>,
	"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: "Kinney, Michael D" <michael.d.kinney@intel.com>
Subject: Re: [PATCH tianocore-docs 2/2] Readme.md: Update the Gitbook documentation section
Date: Tue, 14 Mar 2023 20:19:24 +0000	[thread overview]
Message-ID: <CO1PR11MB4929C78C39D57419D4C85CE2D2BE9@CO1PR11MB4929.namprd11.prod.outlook.com> (raw)
In-Reply-To: <20230314200452.72564-3-rebecca@bsdio.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 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)


      reply	other threads:[~2023-03-14 20:19 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
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 message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-list from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=CO1PR11MB4929C78C39D57419D4C85CE2D2BE9@CO1PR11MB4929.namprd11.prod.outlook.com \
    --to=devel@edk2.groups.io \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox