From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received-SPF: Pass (sender SPF authorized) identity=mailfrom; client-ip=209.132.183.28; helo=mx1.redhat.com; envelope-from=lersek@redhat.com; receiver=edk2-devel@lists.01.org Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id 1D4D62194EB76 for ; Thu, 14 Feb 2019 11:23:08 -0800 (PST) Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.phx2.redhat.com [10.5.11.15]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 7C28BC079C40; Thu, 14 Feb 2019 19:23:07 +0000 (UTC) Received: from lacos-laptop-7.usersys.redhat.com (ovpn-123-153.rdu2.redhat.com [10.10.123.153]) by smtp.corp.redhat.com (Postfix) with ESMTP id C60585D6B3; Thu, 14 Feb 2019 19:23:06 +0000 (UTC) To: Rebecca Cran References: <61170a4b-c4cd-2dba-966c-ec429184d3c9@bluestop.org> From: Laszlo Ersek Cc: edk2-devel Message-ID: <1ce48d85-8a54-fc57-9fa6-9488b62ccd43@redhat.com> Date: Thu, 14 Feb 2019 20:23:05 +0100 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:52.0) Gecko/20100101 Thunderbird/52.9.1 MIME-Version: 1.0 In-Reply-To: <61170a4b-c4cd-2dba-966c-ec429184d3c9@bluestop.org> X-Scanned-By: MIMEDefang 2.79 on 10.5.11.15 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.32]); Thu, 14 Feb 2019 19:23:07 +0000 (UTC) Subject: Re: Issues with EDK-II-Debugging wiki page, and how to submit a pull request for wiki pages X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 14 Feb 2019 19:23:08 -0000 Content-Type: text/plain; charset=utf-8 Content-Language: en-US Content-Transfer-Encoding: 7bit On 02/14/19 18:39, Rebecca Cran via edk2-devel wrote: > I noticed a couple of issues with the page > https://github.com/tianocore/tianocore.github.io/wiki/EDK-II-Debugging - > 'SNI' should be 'SNP', and the |PcdDebugPrintErrorLevel is missing some > entries. > | > > > How do I fork the wiki repo to make a pull request? I suggest the following: (1) clone the wiki to your local workstation. The repo URL is git://github.com/tianocore/tianocore.github.io.wiki (2) In any project that you have *on github*, enable the wiki (specific to that project). Then, add *that* wiki as a "remote" to your local clone that was made in step (1): [remote "mine"] url = git@github.com:GITHUB_USERNAME/PROJECT.wiki.git tagopt = --no-tags The command I recommend is git remote add --no-tags mine \ git@github.com:GITHUB_USERNAME/PROJECT.wiki.git (3) You can develop wiki article changes in your local repo, on a dedicated topic branch. Simply commit and rebase as you see fit. (4) For rendering your local changes, force-push your local topic branch to the master branch of your own wiki: git push --force mine TOPIC_BRANCH:master Then, if you refresh your own wiki page, on github, in your browser, you should see the changes. Please note that this step is destructive, with regard to the personal wiki that you push to. In addition, IIRC, this step requires SSH pubkey auth to be enabled in your github profile. (Step 2 could require it too; I'm not certain.) (5) Once you are done with development, simply format the patches as usual, and submit them to edk2-devel with git-send-email. For formatting, use the parameter --subject-prefix='edk2-wiki PATCH' This will tell reviewers the patches are for the wiki. I can help apply the changes when they are suitably reviewed. I'm not sure if we have designated maintainers/reviewers for wiki pages. Usually there is a related area in edk2, so I guess the edk2 maintainer(s) could double in the docs reviewer role too. > On each page there's > a "Clone this wiki locally" box where I can clone > https://github.com/tianocore/tianocore.github.io.wiki.git, but when I > try and fork it I instead fork > https://github.com/tianocore/tianocore.github.io which doesn't have the > same files either on the master or gh-pages branches - it looks like > https://github.com/tianocore/tianocore.github.io has the files for > www.tianocore.org, not the wiki? The wikis on github are non-intuitive, if you intend to edit them in a normal text editor, locally. I struggled a lot until I came up with the list on top. (It's possible I relied on others' advice in that; I no longer remember.) I hope it helps. Thanks, Laszlo