Re: [edk2-devel] Tianocore-docs Gitbook offline document status (PDF, EPUB, MOBI)

["Michael D Kinney" <michael.d.kinney@intel.com>]

Hi Garret,

That issue has not been resolved.  The only solution to that one is to
reorganize the tables into fewer columns or to see if embedded HTML
produced better results.

Mike

> -----Original Message-----
> From: Kirkendall, Garrett <Garrett.Kirkendall@amd.com>
> Sent: Monday, October 26, 2020 12:20 PM
> To: devel@edk2.groups.io; Kinney, Michael D <michael.d.kinney@intel.com>; Laszlo Ersek <lersek@redhat.com>
> Subject: RE: [edk2-devel] Tianocore-docs Gitbook offline document status (PDF, EPUB, MOBI)
> 
> Frequently in the old PDF documents that were generated, the large/wide tables would get clipped on the right of the page.
> Do you think that will happen with these conversions?
> 
> GARRETT KIRKENDALL
> SMTS Firmware Engineer
> 7171 Southwest Parkway, Austin, TX 78735 USA
> AMD   facebook  |  amd.com
> 
> > -----Original Message-----
> > From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of Michael
> > D Kinney via groups.io
> > Sent: Monday, October 26, 2020 1:58 PM
> > To: Laszlo Ersek <lersek@redhat.com>; devel@edk2.groups.io; Kinney,
> > Michael D <michael.d.kinney@intel.com>
> > Subject: Re: [edk2-devel] Tianocore-docs Gitbook offline document status
> > (PDF, EPUB, MOBI)
> >
> > [CAUTION: External Email]
> >
> > Hello,
> >
> > Laszlo provided some good feedback on the confusing use of 'master'
> > in the links to the 'draft' specifications.  I have made updates to the paths and
> > filenames for the published documents.  This also produces published
> > document files with unique names, so downloaded documents do not have
> > to be manually renamed.  Additional fixes include:
> >
> > * Update to Gitbook Action from 1.2.2 to 1.2.4
> > * Update ignore file rules to be compatible with Gitbook Action and
> >   reduce files copied into HTML version of document in gh-pages.
> > * Consistent use of fonts in all published formats.
> > * Fix links to GitBook markdown in the edk2-TemplateSpecification.
> >
> > The following are the updated links to the published documents from the
> > Gitbook Action running against the edk2-TemplateSpecification.
> >
> > Draft versions from master branch:
> >
> > HTML:
> > https://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2Ftian
> > ocore-docs.github.io%2Fedk2-
> > TemplateSpecification%2Fdraft&amp;data=04%7C01%7Cgarrett.kirkendall%4
> > 0amd.com%7Cb1757ec293c54980acf108d879e116a6%7C3dd8961fe4884e608e
> > 11a82d994e183d%7C0%7C0%7C637393356183052076%7CUnknown%7CTWFp
> > bGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVC
> > I6Mn0%3D%7C1000&amp;sdata=g77DjCQZ1ZiQbQneQB52n7g8PTkTEtUjknEz
> > zYRVXEw%3D&amp;reserved=0
> > PDF:
> > https://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2Ftian
> > ocore-docs.github.io%2Fedk2-TemplateSpecification%2Fdraft%2Fedk2-
> > TemplateSpecification-
> > draft.pdf&amp;data=04%7C01%7Cgarrett.kirkendall%40amd.com%7Cb1757e
> > c293c54980acf108d879e116a6%7C3dd8961fe4884e608e11a82d994e183d%7C0
> > %7C0%7C637393356183052076%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC
> > 4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C1000&
> > amp;sdata=5f00TWjfSfsrIgDz8W5HERvFx3NvNdwNdKPMz0zdLT4%3D&amp;r
> > eserved=0
> > EPUB:
> > https://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2Ftian
> > ocore-docs.github.io%2Fedk2-TemplateSpecification%2Fdraft%2Fedk2-
> > TemplateSpecification-
> > draft.epub&amp;data=04%7C01%7Cgarrett.kirkendall%40amd.com%7Cb175
> > 7ec293c54980acf108d879e116a6%7C3dd8961fe4884e608e11a82d994e183d%7
> > C0%7C0%7C637393356183052076%7CUnknown%7CTWFpbGZsb3d8eyJWIjoi
> > MC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C100
> > 0&amp;sdata=8aE3Uzr4auHFWWaYSDDNGzWpP3wIz5QcYiTiUHdolks%3D&a
> > mp;reserved=0
> > MOBI:
> > https://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2Ftian
> > ocore-docs.github.io%2Fedk2-TemplateSpecification%2Fdraft%2Fedk2-
> > TemplateSpecification-
> > draft.mobi&amp;data=04%7C01%7Cgarrett.kirkendall%40amd.com%7Cb1757
> > ec293c54980acf108d879e116a6%7C3dd8961fe4884e608e11a82d994e183d%7C
> > 0%7C0%7C637393356183052076%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiM
> > C4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C1000
> > &amp;sdata=728KnnsPurwDNyeESC3dtWUxOX%2BYY3VXzJBXZB6icUU%3D&
> > amp;reserved=0
> >
> > Release versions from release/0.2 branch:
> >
> > HTML:
> > https://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2Ftian
> > ocore-docs.github.io%2Fedk2-TemplateSpecification%2Frelease-
> > 0.2&amp;data=04%7C01%7Cgarrett.kirkendall%40amd.com%7Cb1757ec293c
> > 54980acf108d879e116a6%7C3dd8961fe4884e608e11a82d994e183d%7C0%7C0
> > %7C637393356183052076%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjA
> > wMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C1000&amp;s
> > data=ha930LZL2%2FKX3hehBR6hndrucvK77SbRywJMotoJoTg%3D&amp;rese
> > rved=0
> > PDF:
> > https://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2Ftian
> > ocore-docs.github.io%2Fedk2-TemplateSpecification%2Frelease-
> > 0.2%2Fedk2-TemplateSpecification-release-
> > 0.2.pdf&amp;data=04%7C01%7Cgarrett.kirkendall%40amd.com%7Cb1757ec2
> > 93c54980acf108d879e116a6%7C3dd8961fe4884e608e11a82d994e183d%7C0%
> > 7C0%7C637393356183052076%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4
> > wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C1000&a
> > mp;sdata=L3%2BjWeHr3h3ub%2BOSiEym1CCdeUUEfJ6QRek%2Bq2a4Sw4%3
> > D&amp;reserved=0
> > EPUB:
> > https://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2Ftian
> > ocore-docs.github.io%2Fedk2-TemplateSpecification%2Frelease-
> > 0.2%2Fedk2-TemplateSpecification-release-
> > 0.2.epub&amp;data=04%7C01%7Cgarrett.kirkendall%40amd.com%7Cb1757e
> > c293c54980acf108d879e116a6%7C3dd8961fe4884e608e11a82d994e183d%7C0
> > %7C0%7C637393356183052076%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC
> > 4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C1000&
> > amp;sdata=AjibWUY0uDTntpFE6TGWPzBopFKsr70oLoOb0d6ao4s%3D&amp;r
> > eserved=0
> > MOBI:
> > https://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2Ftian
> > ocore-docs.github.io%2Fedk2-TemplateSpecification%2Frelease-
> > 0.2%2Fedk2-TemplateSpecification-release-
> > 0.2.mobi&amp;data=04%7C01%7Cgarrett.kirkendall%40amd.com%7Cb1757e
> > c293c54980acf108d879e116a6%7C3dd8961fe4884e608e11a82d994e183d%7C0
> > %7C0%7C637393356183052076%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC
> > 4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C1000&
> > amp;sdata=svzmT64%2FVOhtKU20im031opnmaM329LG6zCvMFRJtA8%3D&a
> > mp;reserved=0
> >
> > edk2-TemplateSpecification draft source files:
> >
> >
> > https://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgith
> > ub.com%2Ftianocore-docs%2Fedk2-
> > TemplateSpecification&amp;data=04%7C01%7Cgarrett.kirkendall%40amd.co
> > m%7Cb1757ec293c54980acf108d879e116a6%7C3dd8961fe4884e608e11a82d9
> > 94e183d%7C0%7C0%7C637393356183052076%7CUnknown%7CTWFpbGZsb3d
> > 8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%
> > 3D%7C1000&amp;sdata=Fkx%2Fm1pG3mdLfqUcmcBlr0bUu8sAD%2FgFP5QP
> > XrBbwMc%3D&amp;reserved=0
> >
> > edk2-TemplateSpecification published files in gh-pages branch:
> >
> >
> > https://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgith
> > ub.com%2Ftianocore-docs%2Fedk2-TemplateSpecification%2Ftree%2Fgh-
> > pages&amp;data=04%7C01%7Cgarrett.kirkendall%40amd.com%7Cb1757ec29
> > 3c54980acf108d879e116a6%7C3dd8961fe4884e608e11a82d994e183d%7C0%7
> > C0%7C637393356183052076%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4w
> > LjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C1000&am
> > p;sdata=UlfmCeXYwzbm5uftX3fWYtK0gNV0aG76n2QUNFWfW8k%3D&amp;r
> > eserved=0
> >
> > Please let me know if there is any additional feedback on this approach.
> >
> > I will start preparing patches for review against all the Gitbook documents
> > hosted in the tianocore-docs organization.
> >
> > Best regards,
> >
> > Mike
> >
> > > -----Original Message-----
> > > From: Laszlo Ersek <lersek@redhat.com>
> > > Sent: Tuesday, October 20, 2020 1:42 AM
> > > To: Kinney, Michael D <michael.d.kinney@intel.com>;
> > > devel@edk2.groups.io
> > > Subject: Re: [edk2-devel] Tianocore-docs Gitbook offline document
> > > status (PDF, EPUB, MOBI)
> > >
> > > On 10/19/20 22:33, Kinney, Michael D wrote:
> > > > Laszlo,
> > > >
> > > > Yes.  As a quick implementation, I am converting the source branch
> > > > name to a directory name below gh-pages to store the draft and
> > > > multiple releases in the single gh-pages branch.  I could add more
> > > > logic to use better path names if you think that is required.
> > >
> > > No, the current names make sense. Thanks for the explanation.
> > >
> > > >
> > > > I agree it would be good if we could get the one fix for PUML up
> > streamed to GitbookIO.
> > > > If you look at the following Readme you will see it is no longer
> > maintained.
> > > >
> > > >
> > > >
> > https://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgi
> > > >
> > thub.com%2FGitbookIO%2Fgitbook&amp;data=04%7C01%7Cgarrett.kirkend
> > all
> > > >
> > %40amd.com%7Cb1757ec293c54980acf108d879e116a6%7C3dd8961fe4884e6
> > 08e11
> > > >
> > a82d994e183d%7C0%7C0%7C637393356183062074%7CUnknown%7CTWFpbG
> > Zsb3d8ey
> > > >
> > JWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%
> > 7C1
> > > >
> > 000&amp;sdata=ZyEPcWkVgR%2F7tma5CXDfiwq3fqvCcASgZlIHbCunsfA%3D
> > &amp;r
> > > > eserved=0
> > > >
> > > > We are using the majority of the content from the GitbookIO
> > > > projects,  Only the one gitbook plugin for PUML support is being pulled
> > from a fork.
> > > >
> > > > This does means we need to handle any future issues ourselves, and
> > > > if that becomes too much work, we would have to consider a
> > > > conversion to a different publishing service or a different document
> > source format.
> > > >
> > > > The current proposal here is a stop gap to make sure the offline
> > > > documentation is made available to the EDK II Community.
> > >
> > > I agree completely. Introducing this small "external dependency" still
> > > leaves us in a lot better situation than what we're in now (which is
> > > "no offline docs").
> > >
> > > Thanks for the explanation, and for your work on this!
> > > Laszlo
> > >
> > > >
> > > > Thanks,
> > > >
> > > > Mike
> > > >
> > > >
> > > >> -----Original Message-----
> > > >> From: Laszlo Ersek <lersek@redhat.com>
> > > >> Sent: Monday, October 19, 2020 12:00 PM
> > > >> To: devel@edk2.groups.io; Kinney, Michael D
> > > >> <michael.d.kinney@intel.com>
> > > >> Subject: Re: [edk2-devel] Tianocore-docs Gitbook offline document
> > > >> status (PDF, EPUB, MOBI)
> > > >>
> > > >> On 10/16/20 05:48, Michael D Kinney wrote:
> > > >>> Hello,
> > > >>>
> > > >>> I have been working on addressing the gaps in the transition to
> > > >>> the new GitBook services for the TianoCore documents in the
> > > >>> GitBook markdown format.  The major gap is the loss of the offline
> > > >>> PDF, EPUB, and MOBI formats.
> > > >>>
> > > >>> I have found a GitHub action that performs the equivalent work of
> > > >>> the legacy GitBook server and it supports publishing the HTML,
> > > >>> PDF, EPUB, and MOBI formats in a gh-pages branch of a GitBook
> > > >>> document repository.  The gh-pages branch supports the HTML web
> > > >>> view of the documents and is stored as part of the same GitHub
> > > >>> repository that hosts the document source files.
> > > >>>
> > > >>> I have tried this out on the edk2-TemplateSpecification document
> > > >>> in the Tianocore-Docs GitHub organization.
> > > >>>
> > > >>>
> > > >>>
> > https://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2F
> > > >>> github.com%2Ftianocore-docs%2Fedk2-
> > TemplateSpecification&amp;data=
> > > >>>
> > 04%7C01%7Cgarrett.kirkendall%40amd.com%7Cb1757ec293c54980acf108d87
> > > >>>
> > 9e116a6%7C3dd8961fe4884e608e11a82d994e183d%7C0%7C0%7C6373933561
> > 830
> > > >>>
> > 62074%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2l
> > uMzIi
> > > >>>
> > LCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C1000&amp;sdata=WabSHRZhua9qhy
> > AH5Y
> > > >>> 9IjHh6gfIiGpVWzjCWfCR9TYM%3D&amp;reserved=0
> > > >>>
> > > >>> The following is the link to the GitHub actions YML file that
> > > >>> publishes a draft version of the document from the master branch
> > > >>> and the release versions of the document from and release/* branch.
> > > >>>
> > > >>>
> > > >>>
> > https://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2F
> > > >>> github.com%2Ftianocore-docs%2Fedk2-
> > TemplateSpecification%2Fblob%2F
> > > >>> master%2F.github%2Fworkflows%2Fgitbook-
> > action.yml&amp;data=04%7C01
> > > >>>
> > %7Cgarrett.kirkendall%40amd.com%7Cb1757ec293c54980acf108d879e116a6
> > > >>>
> > %7C3dd8961fe4884e608e11a82d994e183d%7C0%7C0%7C63739335618306207
> > 4%7
> > > >>>
> > CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJ
> > BTiI
> > > >>>
> > 6Ik1haWwiLCJXVCI6Mn0%3D%7C1000&amp;sdata=Gre37YIRmAwmnI3Bj2htc
> > yvww
> > > >>> OE4S7yi5%2B96JW62Wv0%3D&amp;reserved=0
> > > >>>
> > > >>> GitBook Action:
> > > >>> * Source:
> > > >>>
> > https://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2F
> > > >>> github.com%2FZanderZhao%2Fgitbook-
> > action&amp;data=04%7C01%7Cgarret
> > > >>>
> > t.kirkendall%40amd.com%7Cb1757ec293c54980acf108d879e116a6%7C3dd896
> > > >>>
> > 1fe4884e608e11a82d994e183d%7C0%7C0%7C637393356183062074%7CUnkn
> > own%
> > > >>>
> > 7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haW
> > wi
> > > >>>
> > LCJXVCI6Mn0%3D%7C1000&amp;sdata=RLFTXQuJhvZYETIONQ%2FsNrAyjoX
> > GUqYN
> > > >>> sGjInKnJD6I%3D&amp;reserved=0
> > > >>> * Docs:
> > > >>>
> > https://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2F
> > > >>> zlogs.net%2Fgitbook-
> > action%2F&amp;data=04%7C01%7Cgarrett.kirkendal
> > > >>>
> > l%40amd.com%7Cb1757ec293c54980acf108d879e116a6%7C3dd8961fe4884e6
> > 08
> > > >>>
> > e11a82d994e183d%7C0%7C0%7C637393356183062074%7CUnknown%7CTWF
> > pbGZsb
> > > >>>
> > 3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0
> > > >>>
> > %3D%7C1000&amp;sdata=wFr1uwVbLuo6nrpa3pdmhktzj%2FSvpmsX%2BNQ
> > XrlCn7
> > > >>> pM%3D&amp;reserved=0
> > > >>
> > > >> Does the above mean that the "GitHub actions YML" file produces a
> > > >> new commit on the gh-pages branch, generated at a particular state
> > > >> (checkout) of the master branch?
> > > >>
> > > >> Also, where is the PDF format stored?
> > > >>
> > > >>>
> > > >>> I found a few issues with the support of embedded PlantUml
> > > >>> diagrams.  A fork of the GitBook puml plugin is available that
> > > >>> addresses these issues.  The book.json file is updated to use this
> > > >>> newer plugin.
> > > >>>
> > > >>>   "plugins": ["puml-aleung"],
> > > >>>
> > > >>> Links to the GitBook puml pluigis:
> > > >>>
> > > >>> Original:
> > > >>>
> > https://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2F
> > > >>> github.com%2FGitbookIO%2Fplugin-
> > puml&amp;data=04%7C01%7Cgarrett.ki
> > > >>>
> > rkendall%40amd.com%7Cb1757ec293c54980acf108d879e116a6%7C3dd8961fe
> > 4
> > > >>>
> > 884e608e11a82d994e183d%7C0%7C0%7C637393356183062074%7CUnknown
> > %7CTW
> > > >>>
> > FpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJX
> > > >>>
> > VCI6Mn0%3D%7C1000&amp;sdata=oTrF4W8gOwPdVI2NqE9jCY30iwWzwJAH
> > oVVdl5
> > > >>> WTSr4%3D&amp;reserved=0
> > > >>> Updated:
> > > >>>
> > https://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2F
> > > >>> github.com%2Faleung%2Fgitbook-plugin-
> > puml&amp;data=04%7C01%7Cgarre
> > > >>>
> > tt.kirkendall%40amd.com%7Cb1757ec293c54980acf108d879e116a6%7C3dd89
> > > >>>
> > 61fe4884e608e11a82d994e183d%7C0%7C0%7C637393356183062074%7CUnkn
> > own
> > > >>>
> > %7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1ha
> > Ww
> > > >>>
> > iLCJXVCI6Mn0%3D%7C1000&amp;sdata=BO%2Be5StDDJGAT%2F192XUMPqE
> > VuLHU0
> > > >>> Ch32XQBPxUhMUo%3D&amp;reserved=0
> > > >>
> > > >> It would be nice if the updates could be upstreamed from aleung's
> > > >> space to GitbookIO.
> > > >>
> > > >>>
> > > >>> The following are the links to the EDK II Template Specification
> > > >>> documents published by this Gitbook Action.  Notice that all the
> > > >>> links are to files in either GitHub repos or the web pages
> > > >>> published by GitHub when a gh-pages branch is present and updated.
> > > >>>
> > > >>> Draft versions from master branch:
> > > >>>
> > > >>> HTML:
> > > >>>
> > https://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2F
> > > >>> tianocore-docs.github.io%2Fedk2-
> > TemplateSpecification%2Fmaster&amp
> > > >>>
> > ;data=04%7C01%7Cgarrett.kirkendall%40amd.com%7Cb1757ec293c54980acf
> > > >>>
> > 108d879e116a6%7C3dd8961fe4884e608e11a82d994e183d%7C0%7C0%7C6373
> > 933
> > > >>>
> > 56183062074%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQ
> > IjoiV2
> > > >>>
> > luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C1000&amp;sdata=H9gBnIamU
> > H1E
> > > >>> 9XyLfX1Fn5xPs629NJNKw%2B3R6zGdxlQ%3D&amp;reserved=0
> > > >>
> > > >> Ugh, confusing. It says "master". I guess it still consumes the
> > > >> "gh-pages" branch.
> > > >>
> > > >>> PDF:
> > > >>>
> > https://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2F
> > > >>> github.com%2Ftianocore-docs%2Fedk2-
> > TemplateSpecification%2Fraw%2Fg
> > > >>> h-
> > pages%2Fmaster%2Fmybook%2Febook.pdf&amp;data=04%7C01%7Cgarrett.
> > k
> > > >>>
> > irkendall%40amd.com%7Cb1757ec293c54980acf108d879e116a6%7C3dd8961f
> > e
> > > >>>
> > 4884e608e11a82d994e183d%7C0%7C0%7C637393356183062074%7CUnknown
> > %7CT
> > > >>>
> > WFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLC
> > J
> > > >>>
> > XVCI6Mn0%3D%7C1000&amp;sdata=ExMS3ib82NlAy8WSDIJNCwIj3QDx%2BY
> > jAlZZ
> > > >>> 1gra8Ato%3D&amp;reserved=0
> > > >>
> > > >> Hmmm. This seems to answer multiple of my questions above. Indeed
> > > >> this binary PDF file exists in the original repo, it is on the
> > > >> gh-pages branch, and "master" is a pathname component (likely
> > > >> showing the branch name that provided the markdown source code for
> > the rendering).
> > > >>
> > > >>> EPUB:
> > > >>>
> > https://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2F
> > > >>> github.com%2Ftianocore-docs%2Fedk2-
> > TemplateSpecification%2Fraw%2Fg
> > > >>> h-
> > pages%2Fmaster%2Fmybook%2Febook.epub&amp;data=04%7C01%7Cgarre
> > tt.
> > > >>>
> > kirkendall%40amd.com%7Cb1757ec293c54980acf108d879e116a6%7C3dd8961
> > f
> > > >>>
> > e4884e608e11a82d994e183d%7C0%7C0%7C637393356183062074%7CUnknow
> > n%7C
> > > >>>
> > TWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiL
> > C
> > > >>>
> > JXVCI6Mn0%3D%7C1000&amp;sdata=SkRHiLNkosN6FWpFvnB68sZDnL9ma7
> > OGfLvd
> > > >>> xzK%2BrY8%3D&amp;reserved=0
> > > >>> MOBI:
> > > >>>
> > https://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2F
> > > >>> github.com%2Ftianocore-docs%2Fedk2-
> > TemplateSpecification%2Fraw%2Fg
> > > >>> h-
> > pages%2Fmaster%2Fmybook%2Febook.mobi&amp;data=04%7C01%7Cgarre
> > tt.
> > > >>>
> > kirkendall%40amd.com%7Cb1757ec293c54980acf108d879e116a6%7C3dd8961
> > f
> > > >>>
> > e4884e608e11a82d994e183d%7C0%7C0%7C637393356183062074%7CUnknow
> > n%7C
> > > >>>
> > TWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiL
> > C
> > > >>>
> > JXVCI6Mn0%3D%7C1000&amp;sdata=Av3mkdu1UTwM%2F6kW52sMtUjyU
> > Mvs3gHQPc
> > > >>> ehUz%2FA8zo%3D&amp;reserved=0
> > > >>>
> > > >>> Release versions from release/0.2 branch:
> > > >>>
> > > >>> HTML:
> > > >>>
> > https://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2F
> > > >>> tianocore-docs.github.io%2Fedk2-TemplateSpecification%2Frelease-0.
> > > >>>
> > 2&amp;data=04%7C01%7Cgarrett.kirkendall%40amd.com%7Cb1757ec293c54
> > 9
> > > >>>
> > 80acf108d879e116a6%7C3dd8961fe4884e608e11a82d994e183d%7C0%7C0%7
> > C63
> > > >>>
> > 7393356183062074%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMD
> > AiLCJQI
> > > >>>
> > joiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C1000&amp;sdata=FMUld
> > Vj
> > > >>>
> > EP6oNz8VLS3KbPb1I9%2B%2BkKoZPLWsgSb%2FMMM0%3D&amp;reserved
> > =0
> > > >>> PDF:
> > > >>>
> > https://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2F
> > > >>> github.com%2Ftianocore-docs%2Fedk2-
> > TemplateSpecification%2Fraw%2Fg
> > > >>> h-pages%2Frelease-
> > 0.2%2Fmybook%2Febook.pdf&amp;data=04%7C01%7Cgarr
> > > >>>
> > ett.kirkendall%40amd.com%7Cb1757ec293c54980acf108d879e116a6%7C3dd8
> > > >>>
> > 961fe4884e608e11a82d994e183d%7C0%7C0%7C637393356183062074%7CUnk
> > now
> > > >>>
> > n%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1ha
> > W
> > > >>>
> > wiLCJXVCI6Mn0%3D%7C1000&amp;sdata=Q7F8NaE703qP6gHlwWujbWK5%2
> > BHqHJk
> > > >>> Ps%2FDXOfPCz%2BBQ%3D&amp;reserved=0
> > > >>> EPUB:
> > > >>>
> > https://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2F
> > > >>> github.com%2Ftianocore-docs%2Fedk2-
> > TemplateSpecification%2Fraw%2Fg
> > > >>> h-pages%2Frelease-
> > 0.2%2Fmybook%2Febook.epub&amp;data=04%7C01%7Cgar
> > > >>>
> > rett.kirkendall%40amd.com%7Cb1757ec293c54980acf108d879e116a6%7C3dd
> > > >>>
> > 8961fe4884e608e11a82d994e183d%7C0%7C0%7C637393356183072070%7CUn
> > kno
> > > >>>
> > wn%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1
> > ha
> > > >>>
> > WwiLCJXVCI6Mn0%3D%7C1000&amp;sdata=V9yMKFQdHknKUlwjnowLsJ%2
> > BYajsbl
> > > >>> elPANzamJuu9aM%3D&amp;reserved=0
> > > >>> MOBI:
> > > >>>
> > https://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2F
> > > >>> github.com%2Ftianocore-docs%2Fedk2-
> > TemplateSpecification%2Fraw%2Fg
> > > >>> h-pages%2Frelease-
> > 0.2%2Fmybook%2Febook.mobi&amp;data=04%7C01%7Cgar
> > > >>>
> > rett.kirkendall%40amd.com%7Cb1757ec293c54980acf108d879e116a6%7C3dd
> > > >>>
> > 8961fe4884e608e11a82d994e183d%7C0%7C0%7C637393356183072070%7CUn
> > kno
> > > >>>
> > wn%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1
> > ha
> > > >>>
> > WwiLCJXVCI6Mn0%3D%7C1000&amp;sdata=JKWxBRXu3Us5l6XU%2BFzbWD
> > yTrvlv0
> > > >>> vSnD89QiP2Svjg%3D&amp;reserved=0
> > > >>>
> > > >>> In order to enable this on all the documents in Tianocore-docs,
> > > >>> the following tasks need to be performed on each document repo:
> > > >>> * Update book.json in master and release/* branches to use the
> > > >>>   newer PlantUML plugin.
> > > >>
> > > >> Again, upstreaming to GitbookIO would be nice. At this time,
> > > >>
> > > >>
> > > >>
> > https://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2Fg
> > > >> ithub.com%2Faleung%2Fgitbook-plugin-
> > puml&amp;data=04%7C01%7Cgarrett
> > > >>
> > .kirkendall%40amd.com%7Cb1757ec293c54980acf108d879e116a6%7C3dd896
> > 1f
> > > >>
> > e4884e608e11a82d994e183d%7C0%7C0%7C637393356183072070%7CUnknow
> > n%7CT
> > > >>
> > WFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLC
> > JX
> > > >>
> > VCI6Mn0%3D%7C1000&amp;sdata=qoQQL1JbKhHydr6XtP%2Fg3asCnzHPjedt
> > I7QFP
> > > >> L261nk%3D&amp;reserved=0
> > > >>
> > > >> reports
> > > >>
> > > >>   "This branch is 2 commits ahead of GitbookIO:master"
> > > >>
> > > >> hmmm... oh wait, the relevant commit is also the subject of PR#8
> > > >> for
> > > >> GitbookIO/plugin-puml:
> > > >>
> > > >>
> > > >>
> > https://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2Fg
> > > >> ithub.com%2FGitbookIO%2Fplugin-
> > puml%2Fissues%2F8&amp;data=04%7C01%7
> > > >>
> > Cgarrett.kirkendall%40amd.com%7Cb1757ec293c54980acf108d879e116a6%7C
> > > >>
> > 3dd8961fe4884e608e11a82d994e183d%7C0%7C0%7C637393356183072070%7
> > CUnk
> > > >>
> > nown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6I
> > k1h
> > > >>
> > aWwiLCJXVCI6Mn0%3D%7C1000&amp;sdata=gYFigqyEILLDZ4yQOfVaogkMtV
> > phw28
> > > >> 3KBQWf8Bd814%3D&amp;reserved=0
> > > >>
> > > >> So why was that PR abandoned?...
> > > >>
> > > >>> * Add the file .github/workflows/gitbook-action.yml to the
> > > >>>   master and release/* branches.
> > > >>> * Force a document build on the master and release/* branches to
> > > >>>   publish all draft and release versions of the documents.
> > > >>>
> > > >>> Please review the content here and the published documents and let
> > > >>> me know if there are any concerns with switching to a GitHub
> > > >>> Action to publish all Tianocore Gitbook markdown based documents.
> > > >>
> > > >> Thank you for researching this!
> > > >>
> > > >> My only concern is that I'd prefer our action scripts to consume
> > > >>
> > https://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2Fg
> > > >>
> > ithub.com%2FGitbookIO&amp;data=04%7C01%7Cgarrett.kirkendall%40amd.
> > c
> > > >>
> > om%7Cb1757ec293c54980acf108d879e116a6%7C3dd8961fe4884e608e11a82d
> > 994
> > > >>
> > e183d%7C0%7C0%7C637393356183072070%7CUnknown%7CTWFpbGZsb3d8
> > eyJWIjoi
> > > >>
> > MC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C100
> > 0&a
> > > >>
> > mp;sdata=Z9Hyyj666z7KahJMEQHcpQv5OcWXvZBa1GvGwbbmhUw%3D&am
> > p;reserve
> > > >> d=0 rather than
> > > >>
> > https://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2Fg
> > > >>
> > ithub.com%2Faleung%2F&amp;data=04%7C01%7Cgarrett.kirkendall%40amd.
> > c
> > > >>
> > om%7Cb1757ec293c54980acf108d879e116a6%7C3dd8961fe4884e608e11a82d
> > 994
> > > >>
> > e183d%7C0%7C0%7C637393356183072070%7CUnknown%7CTWFpbGZsb3d8
> > eyJWIjoi
> > > >>
> > MC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C100
> > 0&a
> > > >>
> > mp;sdata=xBiO%2FPW7x90dvud9OqUhkjtlncvTXbSs0Ccw%2BN0JE0U%3D&a
> > mp;res
> > > >> erved=0 , in the long term. I'd think the former should give us
> > > >> better support in the long term -- although, that may be a foolish
> > > >> hope, given that the PlantUml diagrams issue is only fixed in the
> > > >> latter, at the moment :/
> > > >>
> > > >> Can we somehow talk to Leo Liang? I think we should understand why
> > > >> the PlantUML fix is not part of the offical GitbookIO repo.
> > > >>
> > > >> Thanks!
> > > >> Laszlo
> > > >
> >
> >
> >
> > 
> >