Skip to content

Commit e303db4

Browse files
authored
Styling tweaks (#1614)
* Also denote one must be GH authenticated on OUJS in order for a webhook to work Applies to #1610 Auto-merge
1 parent 12b77b3 commit e303db4

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

views/pages/newScriptPage.html

+14-7
Original file line numberDiff line numberDiff line change
@@ -308,25 +308,32 @@ <h3><i class="octicon octicon-mark-github"></i> GitHub</h3>
308308
<h4>Instructions</h4>
309309
<p>Optionally you may upload the script to the site first. You may also use <a href="{{{authedUser.userGitHubRepoListPageUrl}}}">Import from Github</a> to speed things up as a shortcut.</p>
310310
<ol>
311+
<li>Ensure that you have GitHub as an authentication for this site.</li>
311312
<li>Ensure that you have and use a default <code>master</code> branch.</li>
312313
<li>On your target GitHub repo, click Settings &gt; Webhooks &gt; Add Webhook.</li>
313314
<li>In the Payload URL input, paste<br /><code>https://openuserjs.org/github/hook</code></li>
314315
<li>Change the Content Type dropdown to<br /><code>application/x-www-form-urlencoded</code></li>
315316
<li>Click <code>Add Webhook</code>.</li>
316317
</ol>
317318
<p>After adding the webhook, push a change to GitHub to make sure it's working.</p>
318-
<p>This site will return an acknowledgement to GitHub of acceptance for queued retrieval. Larger payloads will take more time to process.</p>
319-
<p>GitHub has a caching mecahnism that may prevent serving the next version from being pulled too quickly so please give a little time in-between commits.</p>
320-
<p>If the database is locked, such as during brief maintenance periods or lockdown, updates may be temporarily rejected and may need to be redelivered manually.</p>
321-
<p></p>
319+
<h4>Caveats</h4>
320+
<ul class="small">
321+
<li>This site will return an acknowledgement to GitHub of acceptance for queued retrieval. Larger payloads will take more time to process.</li>
322+
<li>GitHub currently has a caching mecahnism that may prevent serving the next version from being pulled too quickly so please give a little time in-between commits.</li>
323+
<li>If the database is locked, such as during brief maintenance periods or lockdown, updates may be temporarily rejected and may need to be redelivered manually.</li>
324+
</ul>
322325
</div>
323326
</div>
324327
<h3><a id="collaboration"></a>Collaboration<a href="#collaboration" class="anchor"><i class="fa fa-link"></i></a></h3>
325328
<div class="panel panel-default">
326329
<div class="panel-body">
327-
<p>To allow other users to upload modified versions of your script to your account from this site create an OpenUserJS metadata block and add the necessary keys... one for you yourself and for every existing user you wish to give write access as demonstrated here:<pre class="small"><code>// ==OpenUserJS==</code><br /><code>// @author {{#authedUser}}{{authedUser.name}}{{/authedUser}}{{^authedUser}}username{{/authedUser}}</code><br /><code>// @collaborator username</code><br /><code>// ==/OpenUserJS==</code></pre> Only the real author of the script may modify these metadata keys.</p>
328-
<p>Collaborators on this site may not use GitHub integration to update the script. Add them as collaborators to the GitHub repository instead.</p>
329-
<p>If the webhook is enabled on the GitHub repository it will clobber any changes here on this site.</p>
330+
<p>To allow other users to upload modified versions of your script to your account from this site create an OpenUserJS metadata block and add the necessary keys... one for you yourself and for every existing user you wish to give write access as demonstrated here:<pre class="small"><code>// ==OpenUserJS==</code><br /><code>// @author {{#authedUser}}{{authedUser.name}}{{/authedUser}}{{^authedUser}}username{{/authedUser}}</code><br /><code>// @collaborator username</code><br /><code>// ==/OpenUserJS==</code></pre></p>
331+
<h4>Caveats</h4>
332+
<ul class="small">
333+
<li>Only the real author of the script may modify these metadata keys.</li>
334+
<li>Collaborators on this site may not use GitHub integration to update the script. Add them as collaborators to the GitHub repository instead.</li>
335+
<li>If the webhook is enabled on the GitHub repository it will clobber any changes here on this site.</li>
336+
</ul>
330337
</div>
331338
</div>
332339
</div>

0 commit comments

Comments
 (0)