Skip to content

Commit

Permalink
Render site
Browse files Browse the repository at this point in the history
  • Loading branch information
@actions-user
actions-user committed Mar 15, 2024
1 parent a58008f commit 189376b
Show file tree
Hide file tree
Showing 8 changed files with 232 additions and 27 deletions.
36 changes: 33 additions & 3 deletions docs/calendly.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -313,9 +313,6 @@ <h4 class="date">15 March, 2024</h4>
</div>


<div id="setting-up-calendly" class="section level2">
<h2>Setting up Calendly</h2>
</div>
<div id="preview" class="section level2">
<h2>Preview</h2>
<pre><code>## Rows: 1 Columns: 10
Expand Down Expand Up @@ -375,6 +372,39 @@ <h2>Preview</h2>
</tbody>
</table>
</div>
<div id="setting-up-calendly" class="section level2">
<h2>Setting Up Calendly</h2>
<ol style="list-style-type: decimal">
<li>To set up calendly authorization <a
href="https://calendly.com/integrations/api_webhooks">go here</a> and
click “Generate Token”.</li>
<li>Underneath “Choose a name for this token” pick a name that will
remind you of this project.</li>
<li>Click “Create Token” and it will send you an authorization code to
your email.</li>
<li>Click “Copy Token” and keep this handy.</li>
<li>Return to your metricminer dashboard repository and go to
<code>Settings</code> &gt; <code>Secrets and variables</code> &gt;
<code>Actions</code>.</li>
<li>Click on <code>New repository secret</code>. Name your new secret
<em>exactly</em> <code>METRICMINER_CALENDLY</code></li>
<li>Paste your token into the <code>Secret</code> box and then click the
green “Add secret” button.</li>
</ol>
<p>After you’ve set up authorization you’ll need to check the following
items in the <code>_config_automation.yml</code> file.</p>
<ul class="task-list">
<li><input type="checkbox" />In the <code>config_automation.yml</code>
file, make sure that <code>refresh-calendly</code> is set to “yes”.</li>
<li><input type="checkbox" />Optionally, if you are saving data to
google, specify a googlesheet ID you’d like the CRAN data to be saved
to. This will only be relevant if you’ve set <code>data_dest</code> to
<code>google</code>.</li>
</ul>
<pre><code>###### Calendly ######
refresh-calendly: yes
calendly_googlesheet:</code></pre>
</div>



Expand Down
30 changes: 27 additions & 3 deletions docs/citations.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -313,9 +313,6 @@ <h4 class="date">15 March, 2024</h4>
</div>


<div id="setting-up-citations" class="section level2">
<h2>Setting up Citations</h2>
</div>
<div id="preview" class="section level2">
<h2>Preview</h2>
<p>Column information:</p>
Expand Down Expand Up @@ -410,6 +407,33 @@ <h2>Preview</h2>
## 1 Open-source Tools for Training Resources–OTTR 5
## 2 What&#39;s the best chatbot for me? Researchers put LLMs through their pace… 2</code></pre>
</div>
<div id="setting-up-citations" class="section level2">
<h2>Setting up Citations</h2>
<ol style="list-style-type: decimal">
<li>Go to: <a href="https://scholar.google.com/scholar"
class="uri">https://scholar.google.com/scholar</a></li>
<li>Search for the paper you are looking for the citation count.</li>
<li>Then click the <code>Cited by ___</code> button below the title of
the paper</li>
<li>Copy and paste this in the <code>_config_automation.yml</code> file
in the <code>citation_papers</code> section.</li>
</ol>
<pre><code>###### Citations ######
refresh-citations: yes
citation_papers: [
&quot;https://scholar.google.com/scholar?cites=6140457238337460780&quot;,
&quot;https://scholar.google.com/scholar?cites=15945159957067506879&quot; ]
citation_googlesheet:</code></pre>
<ul class="task-list">
<li><input type="checkbox" />In the <code>config_automation.yml</code>
file, make sure that <code>refresh-citations</code> is set to
“yes”.</li>
<li><input type="checkbox" />Optionally, if you are saving data to
google, specify a googlesheet ID in <code>citation_googlesheet</code> if
you’d like the citation data to be saved to. This will only be relevant
if you’ve set <code>data_dest</code> to <code>google</code>.</li>
</ul>
</div>



Expand Down
25 changes: 22 additions & 3 deletions docs/cran.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -313,9 +313,6 @@ <h4 class="date">15 March, 2024</h4>
</div>


<div id="setting-up-cran" class="section level2">
<h2>Setting up CRAN</h2>
</div>
<div id="preview" class="section level2">
<h2>Preview</h2>
<pre class="r"><code>library(tidyverse)</code></pre>
Expand Down Expand Up @@ -367,6 +364,28 @@ <h2>Preview</h2>
color = &quot;R Packages&quot;)</code></pre>
<p><img src="cran_files/figure-html/unnamed-chunk-4-1.png" width="672" /></p>
</div>
<div id="setting-up-cran" class="section level2">
<h2>Setting up CRAN</h2>
<p>In the <code>_config_automation.yml</code> you will need to specify a
few things.</p>
<pre><code>###### CRAN ######
refresh-cran: yes
cran_packages: [ metricminer, ottrpal ]
cran_googlesheet:</code></pre>
<ul class="task-list">
<li><input type="checkbox" />In the <code>config_automation.yml</code>
file, make sure that <code>refresh-cran</code> is set to “yes”.</li>
<li><input type="checkbox" />In the <code>cran_packages</code> of your
<code>config_automation.yml</code>, type the names of the packages that
you’d like to collect data from on CRAN. Type them exactly as they are
spelled, case sensitive, separated by commas. Delete the example package
names we’ve put there.</li>
<li><input type="checkbox" />Optionally, if you are saving data to
google, specify a googlesheet ID in <code>cran_googlesheet</code> you’d
like the CRAN data to be saved to. This will only be relevant if you’ve
set <code>data_dest</code> to <code>google</code>.</li>
</ul>
</div>



Expand Down
31 changes: 28 additions & 3 deletions docs/github.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -313,9 +313,6 @@ <h4 class="date">15 March, 2024</h4>
</div>


<div id="setting-up-github" class="section level2">
<h2>Setting up GitHub</h2>
</div>
<div id="preview" class="section level2">
<h2>Preview</h2>
<pre><code>## Rows: 2 Columns: 6
Expand Down Expand Up @@ -455,6 +452,34 @@ <h2>Preview</h2>
</tr>
</tbody>
</table>
<div id="setting-up-github" class="section level3">
<h3>Setting up GitHub</h3>
<p>At this point you should already have your GitHub authorization set
up for your metricminer dashboard by having <a
href="#setting-up-your-dashboard-repository">followed the instructions
above.</a>.</p>
<p>In the <code>_config_automation.yml</code> you will need to specify
items in the GitHub section.</p>
<pre><code>###### GitHub ######
refresh-github: yes
github_repos: [ fhdsl/metricminer, fhdsl/metricminer.org ]
github_googlesheet:</code></pre>
<ul class="task-list">
<li><input type="checkbox" />In the <code>_config_automation.yml</code>
file, make sure that <code>refresh-github</code> is set to “yes”.</li>
<li><input type="checkbox" />In <code>github_repos</code> of your
<code>_config_automation.yml</code>, specify the names of the
repositories you’d like to collect data from in
<code>github_repos</code>. Make sure it includes the
<code>owner/repository</code> e.g. <code>fhdsl/metricminer</code> not
just <code>metricminer</code>. Commas need to separate the repositories.
Delete the example repositories we put there.</li>
<li><input type="checkbox" />Optionally, if you are saving data to
Google, specify a googlesheet ID in <code>github_googlesheet</code>
you’d like the GitHub data to be saved to. This will only be relevant if
you’ve set <code>data_dest</code> to <code>google</code>.</li>
</ul>
</div>
</div>


Expand Down
40 changes: 40 additions & 0 deletions docs/googleanalytics.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -496,6 +496,46 @@ <h2>Preview</h2>
</tr>
</tbody>
</table>
<div id="setting-up-google-analytics-1" class="section level3">
<h3>Setting up Google Analytics</h3>
<p><a href="#setting-up-google-authentication">Follow the steps from the
above section to authenticate Google</a> – make sure that the account
you have authenticated for has access to the Google Analytics properties
you wish to collect.</p>
<p>We’ll need to collect the Google Analytics property IDs for the
websites you want to retrieve data from.</p>
<ol style="list-style-type: decimal">
<li>Go to <a href="https://analytics.google.com/"
class="uri">https://analytics.google.com/</a> – You may have to login.
These instructions are assuming you have already set up Google Analytics
and have been collecting data.</li>
<li>Then click on the website at the top of the navbar. It will bring
you to a dropdown that shows all your websites.</li>
</ol>
<p><img src = "resources/images/google-analytics-dropdown.png" width = "50%"></p>
<p>4 .Click on one of the websites where you’d like to retrieve data
from. The URL will look something like this:</p>
<pre><code>https://analytics.google.com/analytics/web/?authuser=1#/p&lt;PROPERTY_ID_HERE&gt;/reports/home</code></pre>
<ol start="5" style="list-style-type: decimal">
<li>Copy the property id and put it in the <code>ga_property_ids:</code>
part of the <code>_config_automation.yml</code>.</li>
</ol>
<p>Repeat these same steps for all the properties you’d like to collect
data for, separating the IDs by commas. Delete the example IDs we have
put there as placeholders.</p>
<pre><code>###### Google Analytics ######
refresh-ga: yes
ga_property_ids: [ 422671031, 422558989 ]
ga_googlesheet:</code></pre>
<ul class="task-list">
<li><input type="checkbox" />In the <code>config_automation.yml</code>
file, make sure that <code>refresh-ga</code> is set to “yes”.</li>
<li><input type="checkbox" />Optionally, if you are saving data to
Google, specify a googlesheet ID in <code>ga_googlesheet</code> you’d
like the GitHub data to be saved to. This will only be relevant if
you’ve set <code>data_dest</code> to <code>google</code>.</li>
</ul>
</div>
</div>


Expand Down
36 changes: 30 additions & 6 deletions docs/googleforms.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -313,14 +313,8 @@ <h4 class="date">15 March, 2024</h4>
</div>


<div id="setting-up-google-forms" class="section level2">
<h2>Setting up Google Forms</h2>
</div>
<div id="preview" class="section level2">
<h2>Preview</h2>
</div>
<div id="preview-1" class="section level2">
<h2>Preview</h2>
<pre><code>## Rows: 4 Columns: 3
## ── Column specification ────────────────────────────────────────────────────────
## Delimiter: &quot;\t&quot;
Expand Down Expand Up @@ -352,6 +346,36 @@ <h2>Preview</h2>
## 3 ACYDBNgHfXMXKJ7Z8VQe87e-IrBdrBad0mBWjO1UH… Here&#39;s a really … Option A
## 4 ACYDBNgdPc1CkWX1dDycG2cYILE9SLdABPfcRox8W… Here&#39;s a really … Option B</code></pre>
</div>
<div id="setting-up-google-forms" class="section level2">
<h2>Setting up Google Forms</h2>
<p><a href="#setting-up-google-authentication">Follow the steps from the
above section to authenticate Google</a> – make sure that the account
you have authenticated for has access to the Google Forms you wish to
collect.</p>
<p>Go to a form you’d like to collect data from. The URL should look
something like this:</p>
<pre><code>https://docs.google.com/forms/u/1/d/&lt;GOOGLE_FORM_ID_HERE&gt;/edit?usp=drive_web</code></pre>
<p>Extract the Google Form ID from the URL and put it in the
<code>google_forms</code> section of the
<code>_config_automation.yml</code> file. Do this for each form you’d
like to collect data from and separate the form IDs with commas. Delete
the example IDs we have put there as placeholders.</p>
<pre><code>###### Google Forms ######
refresh-googleforms: yes
google_forms: [
1pbFfgUPYH2w9zEoCDjCa4HFOxzEhGOseufw28Xxmd-o,
1JjmsiuVoGSxvl-1M_oWittcftO955tijzeNc-cgJlo8 ]
googleforms_googlesheet:</code></pre>
<ul class="task-list">
<li><input type="checkbox" />In the <code>config_automation.yml</code>
file, make sure that <code>refresh-googleforms</code> is set to
“yes”.</li>
<li><input type="checkbox" />Optionally, if you are saving data to
Google, specify a googlesheet ID in <code>googleforms_googlesheet</code>
you’d like the GitHub data to be saved to. This will only be relevant if
you’ve set <code>data_dest</code> to <code>google</code>.</li>
</ul>
</div>



Expand Down
30 changes: 24 additions & 6 deletions docs/slido.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -313,14 +313,8 @@ <h4 class="date">15 March, 2024</h4>
</div>


<div id="setting-up-slido" class="section level2">
<h2>Setting up Slido</h2>
</div>
<div id="preview" class="section level2">
<h2>Preview</h2>
</div>
<div id="preview-1" class="section level2">
<h2>Preview</h2>
<pre><code>## Rows: 14 Columns: 5
## ── Column specification ────────────────────────────────────────────────────────
## Delimiter: &quot;\t&quot;
Expand Down Expand Up @@ -354,6 +348,30 @@ <h2>Preview</h2>
##
## ℹ Use `spec()` to retrieve the full column specification for this data.
## ℹ Specify the column types or set `show_col_types = FALSE` to quiet this message.</code></pre>
<div id="setting-up-slido" class="section level3">
<h3>Setting up Slido</h3>
<p>This is assuming you have already exported Slido data to a google
drive folder. See <a
href="https://community.slido.com/analytics-and-exports-44/export-your-questions-poll-results-quiz-leaderboard-and-ideas-532">Slido
instructions here</a> for how to do that. Navigate to the Google Drive
folder that has the Slidos you’d like to collect. Get the URL for this
folder. It should look like this:</p>
<pre><code>https://drive.google.com/drive/u/1/folders/&lt;SOME_FOLDER_ID_HERE&gt;</code></pre>
<p>Put the folder id from this URL in your <code>drive_id:</code>
category in the <code>_config_automation.yml</code> file.</p>
<pre><code>###### Slido ######
refresh-slido: yes
drive_id: 1XWXHHyj32Uw_UyaUJrqp6S--hHnM0-7l
slido_googlesheet:</code></pre>
<ul class="task-list">
<li><input type="checkbox" />In the <code>config_automation.yml</code>
file, make sure that <code>refresh-slido</code> is set to “yes”.</li>
<li><input type="checkbox" />Optionally, if you are saving data to
Google, specify a googlesheet ID in <code>slido_googlesheet</code> that
you’d like the GitHub data to be saved to. This will only be relevant if
you’ve set <code>data_dest</code> to <code>google</code>.</li>
</ul>
</div>
</div>


Expand Down
31 changes: 28 additions & 3 deletions docs/youtube.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -313,9 +313,6 @@ <h4 class="date">15 March, 2024</h4>
</div>


<div id="setting-up-youtube" class="section level2">
<h2>Setting up Youtube</h2>
</div>
<div id="preview" class="section level2">
<h2>Preview</h2>
<pre><code>## Rows: 2 Columns: 6
Expand Down Expand Up @@ -365,6 +362,34 @@ <h2>Preview</h2>
</tr>
</tbody>
</table>
<div id="setting-up-youtube" class="section level3">
<h3>Setting up YouTube</h3>
<p><a href="#setting-up-google-authentication">Follow the steps from the
above section to authenticate Google</a> – make sure that the account
you have authenticated for has access to the YouTube you wish to
collect.</p>
<p>Go to a video you’d like to collect data from. The URL should look
something like this:</p>
<pre><code>https://www.youtube.com/watch?v=&lt;YOUTUBE_VIDEO_ID_HERE&gt;</code></pre>
<p>Extract the Youtube Video ID from the URL and put it in the
<code>video_ids</code> section of the
<code>_config_automation.yml</code> file. Delete the example IDs we have
put there as placeholders. Do this for each video you’d like to collect
data from and separate the IDs with commas.</p>
<pre><code>###### YouTube ######
refresh-youtube: yes
video_ids: [ XN_QPRrJZAw, YkYnni-WuaQ ]
youtube_googlesheet:</code></pre>
<ul class="task-list">
<li><input type="checkbox" />In the <code>config_automation.yml</code>
file, make sure that <code>refresh-slido</code> is set to “yes”.</li>
<li><input type="checkbox" />Optionally, if you are saving data to
Google, specify a googlesheet ID in <code>youtube_googlesheet</code>
that you’d like the GitHub data to be saved to. This will only be
relevant if you’ve set <code>data_dest</code> to
<code>google</code>.</li>
</ul>
</div>
</div>


Expand Down

0 comments on commit 189376b

Please sign in to comment.