You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Finished: The peer-review process is now initiated
521
549
</a>
522
550
523
551
</li>
@@ -574,11 +602,7 @@ <h2 id="step-1-organize-your-template-tree">Step 1: Organize your template tree<
574
602
<pclass="admonition-title">Examples</p>
575
603
<p>Please check the formatting of existing templates in the <ahref="../../browse/">Archive browser</a></p>
576
604
</div>
577
-
<h2id="step-2-create-a-new-public-project-at-osfio">Step 2: Create a new public project at osf.io<aclass="headerlink" href="#step-2-create-a-new-public-project-at-osfio" title="Permanent link">¶</a></h2>
578
-
<p>Head to <ahref="https://osf.io/dashboard">your OSF home</a> and create a new project.
579
-
Make sure you <strong>make your project public</strong> and write down the project identifier from the URL.</p>
<h2id="step-3-install-the-templateflow-manager-and-tfmgr-add-your-template">Step 3: Install the TemplateFlow Manager and <code>tfmgr add</code> your template<aclass="headerlink" href="#step-3-install-the-templateflow-manager-and-tfmgr-add-your-template" title="Permanent link">¶</a></h2>
605
+
<h2id="step-2-install-the-templateflow-manager">Step 2: Install the <em>TemplateFlow Manager</em><aclass="headerlink" href="#step-2-install-the-templateflow-manager" title="Permanent link">¶</a></h2>
$<spanclass="w"></span><spanclass="nb">export</span><spanclass="w"></span><spanclass="nv">GITHUB_PASSWORD</span><spanclass="o">=</span><spanclass="s1">'****'</span><spanclass="w"></span><spanclass="c1"># or personal access token</span>
615
+
<h2id="step-3-prepare-your-credentials-for-authentication">Step 3: Prepare your credentials for authentication<aclass="headerlink" href="#step-3-prepare-your-credentials-for-authentication" title="Permanent link">¶</a></h2>
616
+
<p><strong>On OSF.io</strong>: First, generate a personal authentication token (PAT) to authenticate your username and be able to upload data to OSF.
617
+
Good guidelines <ahref="https://mjaquiery.github.io/jspsych-born-open-data/osf-pat/index.html">on how to create your PAT on OSF are given here</a>.</p>
618
+
<p><strong>On GitHub</strong>: Then, you also want to generate a PAT to authenticate against GitHub.
619
+
If you are unsure of how to properly create one, please follow the <ahref="https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens">official guidelines</a>, in particular, it is likely easier to avoid permissions problems if you take the <ahref="https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic">classic tokens route</a>.</p>
620
+
<divclass="admonition critical">
621
+
<pclass="admonition-title">Make sure you store both tokens safely and that you will be able to retrieve them later</p>
622
+
</div>
623
+
<p><strong>At this point, you can set up your credentials</strong></p>
624
+
<divclass="codehilite"><pre><span></span><code>$<spanclass="w"></span><spanclass="nb">export</span><spanclass="w"></span><spanclass="nv">OSF_TOKEN</span><spanclass="o">=</span><spanclass="s1">'<copy and paste your OSF PAT here>'</span>
625
+
$<spanclass="w"></span><spanclass="nb">export</span><spanclass="w"></span><spanclass="nv">GITHUB_USER</span><spanclass="o">=</span><spanclass="s1">'<your GitHub handle>'</span><spanclass="w"></span><spanclass="c1"># For instance, 'oesteban'</span>
626
+
$<spanclass="w"></span><spanclass="nb">export</span><spanclass="w"></span><spanclass="nv">GITHUB_TOKEN</span><spanclass="o">=</span><spanclass="s1">'<copy and paste your GitHub PAT here>'</span>
627
+
</code></pre></div>
597
628
598
-
<spanclass="c1"># Assuming the template is at the current directory, under tpl-Name/</span>
<h2id="finished-the-peer-review-process-is-now-initiated">Finished: The peer-review process is now initiated<aclass="headerlink" href="#finished-the-peer-review-process-is-now-initiated" title="Permanent link">¶</a></h2>
635
+
<p>Once <code>tfmgr add</code> has concluded successfully, you'll be provided with a URL that points to a newly created PR against the templateflow superdataset.
636
+
That means your PR will now be listed at the <ahref="https://github.com/templateflow/templateflow/pulls"><code>templateflow/templateflow</code> repo</a>.
637
+
Now, the <ahref="https://github.com/orgs/templateflow/teams/maintainers"><em>TemplateFlow</em> maintainers</a> will carry out <em>editorial management</em> of your proposed template and have it peer-reviewed before it is finally <em>merged</em> into <em>TemplateFlow</em>.</p>
0 commit comments