HPR/hpr_generator
8
1
Fork 5
Code Issues 38 Pull Requests 2 Actions Packages Projects Releases Wiki Activity

Updating documentation

Browse Source
This commit is contained in:
Ken Fallon
2026-05-28 13:28:49 +02:00
parent 640606b8ab
commit a7e1c2f050
1 changed files with 49 additions and 97 deletions
Download Patch File Download Diff File Expand all files Collapse all files

134
templates/content-contribute.tpl.html
View File

@@ -13,6 +13,12 @@
<li><a href="<!--% absolute_url(baseurl,'contribute.html#schedule') %-->">You determine when your show will be released</a></li>
<li><a href="<!--% absolute_url(baseurl,'contribute.html#utf8') %-->">We use UTF-8 end to end</a></li>
<li><a href="<!--% absolute_url(baseurl,'contribute.html#accessibility') %-->">Keep accessibility in mind</a></li>
<li><a href="<!--% absolute_url(baseurl,'contribute.html#international') %-->">Your show will be heard by an International Audience</a></li>
</ul>
<li><a href="<!--% absolute_url(baseurl,'contribute.html#pick_a_topic') %-->">Pick a Topic</a></li>
<ul>
<li><a href="<!--% absolute_url(baseurl,'contribute.html#') %-->"></a></li>
<li><a href="<!--% absolute_url(baseurl,'contribute.html#') %-->"></a></li>
<li><a href="<!--% absolute_url(baseurl,'contribute.html#') %-->"></a></li>
<li><a href="<!--% absolute_url(baseurl,'contribute.html#') %-->"></a></li>
</ul>
@@ -21,14 +27,17 @@
<li><a href="<!--% absolute_url(baseurl,'contribute.html#') %-->"></a></li>
<li><a href="<!--% absolute_url(baseurl,'contribute.html#') %-->"></a></li>
<li><a href="<!--% absolute_url(baseurl,'contribute.html#') %-->"></a></li>
<li><a href="<!--% absolute_url(baseurl,'contribute.html#') %-->"></a></li>
<li><a href="<!--% absolute_url(baseurl,'contribute.html#') %-->"></a></li>
</ul>
<div class="lane stack">
<article>
<header>
<p class="index-link"><a href="/contribute.html#TOP">↑ Go to top</a></p>
<h1 id="so_you_want_to_record_a_podcast">So you want to record a podcast<a href="<!--% absolute_url(baseurl,'contribute.html#so_you_want_to_record_a_podcast') %-->">.</a></h1>
</header>
<p>Well you've come to the right place.</p>
<p>Our goal here at HPR is to make it as easy as possible for you to get your show released.
<p>Well you've come to the right place.
Our goal here at HPR is to make it as easy as possible for you to get your show released.
We take care of the hard bits so you don't need to.
</p>
@@ -36,9 +45,10 @@ We take care of the hard bits so you don't need to.
Recording your first show can be a daunting prospect but <a href="<!--% absolute_url(baseurl) %-->correspondents/index.html">hundreds of people</a>
like yourself have done it, and so can you.
Don't worry that we won't like the topic, just have a look at our <a href="<!--% absolute_url(baseurl) %-->eps/index.html">Archive</a>
to see how diverse the contributions have been.
Also don't worry too mush about the quality of your audio,
that you sound funny,
to see how diverse the contributions have been.</p>
<p>
Don't worry if your audio isn't perfect,
that your voice sounds funny,
that English isn't your native language,
that you suffer from a <a href="<!--% absolute_url(baseurl,'/eps/hpr1102/index.html') %-->">speech impediment</a>,
that your show has loads of ummms and awws in it, etc.
@@ -49,8 +59,8 @@ At the end of the day the show is about the content and less about perfection.
That's not to say we won't help you with ways to improve the audio if you wish,
or narrate your script for you if you can't or won't record it yourself.
</p>
</article>
<div class="lane stack">
<article>
<header>
<p class="index-link"><a href="/contribute.html#TOP">↑ Go to top</a></p>
@@ -172,20 +182,20 @@ which describes the agreed approach to this topic.
</details>
<details>
<summary id="schedule">You determine when your show will be scheduled<a href="<!--% absolute_url(baseurl,'contribute.html#schedule') %-->">.</a></summary>
<summary id="schedule">You determine when your show will be <strong>scheduled</strong><a href="<!--% absolute_url(baseurl,'contribute.html#schedule') %-->">.</a></summary>
<p>You decide when you upload your show <a href="<!--% absolute_url(baseurl,'contribute.html#upload_your_show') %-->">when it should be released</a>.
You can pick a day, or put it in the reserve pool and let the Janitors use it there are free slots.</p>
</details>
<details>
<summary id="utf8">We use UTF-8 end to end<a href="<!--% absolute_url(baseurl,'contribute.html#utf8') %-->">.</a></summary>
<summary id="utf8">We use <strong>UTF-8</strong> end to end<a href="<!--% absolute_url(baseurl,'contribute.html#utf8') %-->">.</a></summary>
<blockquote>See the video "<a href="https://www.youtube.com/watch?v=MijmeoH9LT4">Characters, Symbols and the Unicode Miracle -
Computerphile</a>" for an interesting background to ASCII and <a href="https://en.wikipedia.org/wiki/UTF-8">UTF-8</a>.
</blockquote>
</details>
<details>
<summary id="accessibility">Keep accessibility in mind<a href="<!--% absolute_url(baseurl,'contribute.html#accessibility') %-->">.</a></summary>
<summary id="accessibility">Keep <strong>accessibility</strong> in mind<a href="<!--% absolute_url(baseurl,'contribute.html#accessibility') %-->">.</a></summary>
<p>
When you includes output from the command line in the show notes,
posting screen-shots of console or terminal output
@@ -203,7 +213,7 @@ That way everyone can benefit from the description.
</details>
<details>
<summary id="international">Your show will be heard by an International Audience<a href="<!--% absolute_url(baseurl,'contribute.html#international') %-->">.</a></summary>
<summary id="international">Your show will be heard by an <strong>International Audience</strong><a href="<!--% absolute_url(baseurl,'contribute.html#international') %-->">.</a></summary>
<p>
We have people listening from all over the world, who may not have the same cultural background as yourself,
therefore you should be as clear as possible when giving details.
@@ -231,76 +241,27 @@ If you have any questions please join one of our <a href="<!--% absolute_url(bas
</article>
<div class="lane stack">
<article>
<header>
<p class="index-link"><a href="/contribute.html#TOP">↑ Go to top</a></p>
<h1 id="pick_a_topic">Pick a Topic<a href="<!--% absolute_url(baseurl,'contribute.html#pick_a_topic') %-->">.</a></h1>
</header>
<h2 id="select_a_topic">2. Select a Topic<a href="<!--% absolute_url(baseurl,'contribute.html#select_a_topic') %-->">.</a></h2>
<p>
The first thing you will need to do is decide on a topic for your show. You might already have an
idea but if not you can have a look at our <a href="<!--% absolute_url(baseurl) %-->eps/index.html">Archive</a>
page for examples of shows people have recorded in the past. You can also look at our
The first thing you will need to do is decide on a topic for your show.
OMG I just learned, broke, hacked, discovered this cool thing and noone in my house get’s it.
Check out our 91 in depth series, or 6,938 unique tags for ideas.
You might already have an idea,
but if not you can have a look at our <a href="<!--% absolute_url(baseurl) %-->eps/index.html">Archive</a> page for examples of shows people have recorded in the past.
<p id="requested topics">
We maintain a page of <a href="https://repo.anhonesthost.net/HPR/hpr_documentation/src/branch/main/requested_topics">requested topics</a>
that have been sent in by the community.
Feel free to add it to the list via <a href="<!--% absolute_url(baseurl,'about.html#contact') %-->">the contact channels</a>.
</p>
<a href="<!--% absolute_url(baseurl,'contribute.html#requested_topics') %-->">Requested Topics</a>, or our
<a href="<!--% absolute_url(baseurl) %-->series/index.html">Series</a> page to see if you can add your knowledge to the pool.
</p>
@@ -313,6 +274,8 @@ If you can't think of anything to talk about then please just record a show tell
as a way to introducing yourself to the community.
</p>
</article>
<h2 id="record_your_show">3. Record your show<a href="<!--% absolute_url(baseurl,'contribute.html#record_your_show') %-->">.</a></h2>
<p>
Please select <a href="<!--% absolute_url(baseurl,'contribute.html#recording_a_podcast') %-->">more detailed information</a>
@@ -527,17 +490,6 @@ and chat with a live person 24/7.
</p>
</article>
<hr class="no-css">
<article>
<header>
<p class="index-link"><a href="/contribute.html#TOP">↑ Go to top</a></p>
<h1 id="requested_topics">Requested topics<a href="<!--% absolute_url(baseurl,'contribute.html#requested_topics') %-->">.</a></h1>
</header>
<p>
We maintain a page of <a href="https://repo.anhonesthost.net/HPR/hpr_documentation/src/branch/main/requested_topics">requested topics</a> that have been sent in by the community.
Feel free to add it to the list via <a href="<!--% absolute_url(baseurl,'about.html#contact') %-->">the contact channels</a>.</p>
<hr class="no-css">
<article>
<header>