EDK2 documents and wiki

EDK2 documents and wiki

[Samer El-Haj-Mahmoud]

[-- Attachment #1: Type: text/plain, Size: 1320 bytes --]

I have a question on updating EDK2 documents and wiki.

I am trying to upload the SCT documents (contributed from UEFI Forum) to TianoCore Github and website. These are currently PDF and Word documents, so not suitable to be stand-alone markdown repos in  https://github.com/tianocore-docs<https://github.com/tianocore-docsf> yet (like what is happening wiht the other specs). It seems that, at least for now, the best location as far as I can tell is:


  1.  Add the raw PDF /Word (ZIP) documents to https://github.com/tianocore-docs/Docs/tree/master/User_Docs
  2.  Update https://github.com/tianocore/tianocore.github.io/wiki/EDK-II-User-Documentation to point to the raw documents


For (1), should I send a patch to the list, or simply create a pull request with the files? I ask because I see a pull request pending since 2018 😊 (https://github.com/tianocore-docs/Docs/pull/1)

I assume for (2) I need to send a patch to the list, once (1) are uploaded.

Thanks,
--Samer
IMPORTANT NOTICE: The contents of this email and any attachments are confidential and may also be privileged. If you are not the intended recipient, please notify the sender immediately and do not disclose the contents to any other person, use it for any purpose, or store or copy the information in any medium. Thank you.

[-- Attachment #2: Type: text/html, Size: 9797 bytes --]

Re: EDK2 documents and wiki

[Michael D Kinney]

[-- Attachment #1: Type: text/plain, Size: 2098 bytes --]

Hi Samer,

I would prefer to see a PDF instead of a Word doc if PDF is available.

I agree that https://github.com/tianocore-docs/Docs is the right repo.

We do not use PRs on that repo.  If you create a personal fork of the Docs repo and add a branch with your new documents, you can send a review email with a link to your branch instead of patch review email with the entire document.

The markdown documents in tianocore-docs use the patch review email process.

Mike


From: Samer El-Haj-Mahmoud <Samer.El-Haj-Mahmoud@arm.com>
Sent: Wednesday, November 11, 2020 1:50 PM
To: EDK II Development <devel@edk2.groups.io>; Kinney, Michael D <michael.d.kinney@intel.com>
Cc: Samer El-Haj-Mahmoud <Samer.El-Haj-Mahmoud@arm.com>
Subject: EDK2 documents and wiki

I have a question on updating EDK2 documents and wiki.

I am trying to upload the SCT documents (contributed from UEFI Forum) to TianoCore Github and website. These are currently PDF and Word documents, so not suitable to be stand-alone markdown repos in  https://github.com/tianocore-docs<https://github.com/tianocore-docsf> yet (like what is happening wiht the other specs). It seems that, at least for now, the best location as far as I can tell is:


  1.  Add the raw PDF /Word (ZIP) documents to https://github.com/tianocore-docs/Docs/tree/master/User_Docs
  2.  Update https://github.com/tianocore/tianocore.github.io/wiki/EDK-II-User-Documentation to point to the raw documents


For (1), should I send a patch to the list, or simply create a pull request with the files? I ask because I see a pull request pending since 2018 😊 (https://github.com/tianocore-docs/Docs/pull/1)

I assume for (2) I need to send a patch to the list, once (1) are uploaded.

Thanks,
--Samer
IMPORTANT NOTICE: The contents of this email and any attachments are confidential and may also be privileged. If you are not the intended recipient, please notify the sender immediately and do not disclose the contents to any other person, use it for any purpose, or store or copy the information in any medium. Thank you.

[-- Attachment #2: Type: text/html, Size: 46391 bytes --]