From: "Rebecca Cran" <rebecca@bsdio.com>
To: devel@edk2.groups.io, mikuback@linux.microsoft.com,
quic_rcran@quicinc.com
Cc: Sean Brogan <sean.brogan@microsoft.com>,
Michael D Kinney <michael.d.kinney@intel.com>,
Liming Gao <gaoliming@byosoft.com.cn>
Subject: Re: [edk2-devel] [edk2-wiki][PATCH v3 1/4] Add initial How to Build with Stuart Document
Date: Mon, 12 Dec 2022 22:25:23 -0700 [thread overview]
Message-ID: <b1dcd940-e47b-1cb7-225e-4b4db1a9b32d@bsdio.com> (raw)
In-Reply-To: <c47e517d-cac9-1a99-4d86-c355093385c4@linux.microsoft.com>
According to
https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/organizing-information-with-collapsed-sections,
it looks like normal markdown _should_ apply within collapsed sections?
I noticed a few problems with
https://github.com/tianocore/tianocore.github.io/wiki/How-to-Build-With-Stuart
:
Example: git clone edk2
Should probably be: git clone https://github.com/tianocore/edk2.git
The Linux instructions for creating a python virtual environment should
probably be:
python3 -m venv .venv
Though I've been installing the stuart tools into ~/.local/bin which
allows you to skip the step of using a virtual environment.
Lastly, the Git Submodules step says to use --recursive, which I seem to
recall other instructions suggesting _not_ to use, since it's not needed.
--
Rebecca Cran
On 12/8/22 07:21, Michael Kubacki wrote:
> I write it by hand. HTML comes in because I'm using collapsing content
> via <summary> sections. Once in those sections, normal markdown
> formatting does not apply. I've limited HTML usage in those sections
> to very simple tags that mostly map directly to features allowed in
> markdown formatting as well (<strong> -> **, <a> -> [](), <code> ->
> ``, etc.)
>
> Thanks,
> Michael
>
> On 12/7/2022 11:47 PM, Rebecca Cran wrote:
>> What tool do you use to write the pages?
>>
>> It seems to be a mixture of markdown and HTML: for example I'm
>> surprised to see things like "<strong>C Compiler</strong>" - I'd
>> expect something like "**C Compiler**" instead.
>>
>
>
>
>
>
next prev parent reply other threads:[~2022-12-13 5:25 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-12-07 16:23 [edk2-wiki][PATCH v3 0/4] Add new edk2 build instructions Michael Kubacki
2022-12-07 16:24 ` [edk2-wiki][PATCH v3 1/4] Add initial How to Build with Stuart Document Michael Kubacki
2022-12-08 4:47 ` [edk2-devel] " Rebecca Cran
2022-12-08 14:21 ` Michael Kubacki
2022-12-08 15:53 ` Rebecca Cran
2022-12-13 5:25 ` Rebecca Cran [this message]
2022-12-13 14:17 ` Michael Kubacki
2022-12-07 16:24 ` [edk2-wiki][PATCH v3 2/4] Add initial container usage instructions Michael Kubacki
2022-12-07 16:24 ` [edk2-wiki][PATCH v3 3/4] Add top-level build instructions file Michael Kubacki
2022-12-07 16:24 ` [edk2-wiki][PATCH v3 4/4] Update existing build instructions Michael Kubacki
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=b1dcd940-e47b-1cb7-225e-4b4db1a9b32d@bsdio.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