Merge pull request 'I6 - Adding developer environment setup instructions' (#7) from paulj/hpr_documentation:adding-developer-setup-information into main

Reviewed-on: HPR/hpr_documentation#7
Reviewed-by: Roan Horning <rho_n@josh@anhonesthost.com>

README.md

@@ -29,10 +29,11 @@ Where we can track topics that have been requested, and link to shows that addre
   - EMAIL_LINK_CLICKED - The host clicked the link and is about to upload the show.
   - SHOW_SUBMITTED - upload complete
 - [Processing Show Notes](https://repo.anhonesthost.net/HPR/hpr_documentation/src/branch/main/workflow/processing_a_show.md)
+  - TRANSCRIBING_COMPLETE
   - SHOW_POSTED - show in the database
-- MEDIA_TRANSCODED - audio all generated
+- MEDIA_TRANSCODED - audio all generated and sent to CCDN
 - UPLOADED_TO_IA - on the IA and visible
-- UPLOADED_TO_RSYNC_NET - archived on rsync.net
+- PROCESSING_COMPLETE - all processing is complete
 
 
 - Posting Show

developer_information.md

@@ -12,6 +12,10 @@ Any software development is done with the goal of supporting the distribution of
 
 The priority is to keep the flow of shows coming in and going out, fix any accessibility issue that arise, then work on any other feature requests.
 
+Some things we can change without discussion but other things we need to get input from the [HPR Community](https://hackerpublicradio.org/about.html#governance).
+
+Changes can take a long time, community approval can take several months, while other changes require a lot of work from volunteers who are focused on other priorities.
+
 We allow redistribution by releasing all our content under a [Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0)](https://creativecommons.org/licenses/by-sa/4.0/). In the same vein all our code is released under [aGPLv3](https://www.gnu.org/licenses/agpl-3.0.en.html), or other [OSI approved licenses](https://opensource.org/licenses) .
 
 We do not track statistics to the detriment of our prime directive.
@@ -26,6 +30,8 @@ We have a distrust of online platforms, libraries and niche tools (that we do no
 
 We are very conservative in our choice of tech. As a rule of thumb, all software choices tend to be technology that was developed years ago, and is likely to be around for years to come. 
 
+We make our code as simple to understand as possible as our replacement may not have the skill set we do.
+
 That said, we move with the times when there is a clear advantage to do so.
 
 We run up to date patched stable software.
@@ -46,11 +52,11 @@ Bug reports, and patches are welcome from anyone without commitment.
 
 If you are contributing new code, or new technology we ask you commit to supporting it for a *minimum of two years*. This allows the other Janitors time to learn the new tech and support it when you leave.
 
-Some things we can change without discussion but other things we need to get input from the [HPR Community](https://hackerpublicradio.org/about.html#governance).
-
 ## Create an Account
 
 If you're happy with all that, then...
 
 In order to contribute you need to [create an account](https://repo.anhonesthost.net/user/sign_up), but you **also** need to notify the admins@hpr either via email, mastodon, or matrix that you have created an account. Due to the level of spam accounts we need to approve each one by one.
 
+Changes can be submittted as described in [hpr3797 :: How to submit changes to HPR](https://hackerpublicradio.org/eps/hpr3797/index.html).
+

set-up-development-environment.md

@@ -0,0 +1,77 @@
+# Setting up a Local Development Environment
+In order to work on the HPR codebase, first of all create your
+account, as explained in [developer information](developer_information.md).
+
+## Create your local environment
+The next step is to create your development environment locally:
+1. Fork the HPR repository you want to work on. Do this by clicking
+   the Fork button top right in the repository header:
+   
+   ![repository header](assets/images/repository-header.png)
+   
+2. Go to your terminal on your computer, and clone the HPR repository
+   locally:
+   ```` 
+   $ git clone gitea@repo.anhonesthost.net:HPR/hpr_documentation.git
+   ````
+   It doesn't matter if you use the ssh or http link for the code -
+   you don't have write access to the main repository, so you won't be
+   pushing code back there.
+3. Change to the clone repository - you will now see the remote listed
+   as origin:
+   ````
+   $ cd hpr_documentation
+   $ git remote -v
+   origin	gitea@repo.anhonesthost.net:HPR/hpr_documentation.git (fetch)
+   origin	gitea@repo.anhonesthost.net:HPR/hpr_documentation.git (push)
+   ````
+4. Create a remote for your fork of the repository:
+   ````
+   $ git remote add upstream gitea@repo.anhonesthost.net:[YOUR_USER]/hpr_documentation.git
+   $ git remote -v
+   origin	gitea@repo.anhonesthost.net:HPR/hpr_documentation.git (fetch)
+   origin	gitea@repo.anhonesthost.net:HPR/hpr_documentation.git (push)
+   upstream	gitea@repo.anhonesthost.net:[YOUR_USER]/hpr_documentation.git (fetch)
+   upstream	gitea@repo.anhonesthost.net:[YOUR_USER]/hpr_documentation.git (push)
+   ````
+
+You now have a repository you can keep up to date with the main repo,
+and also work on making additions.
+
+## Making code changes
+1. In order to make changes, the first step is to update your local
+   repository:
+   ````
+   $ git checkout main    # In case you are still in a branch from an earlier change
+   $ git pull origin
+   ````
+2. Create a branch to work on the changes:
+   ````
+   $ git checkout -b adding-developer-setup-information
+   ````
+3. Make the changes
+4. Check the changes work! You don't want to push broken code upstream!
+5. Commit your changes locally
+   ````
+   $ git add *
+   $ git commit 
+   ````
+   Note - the commit message should have the issue number at the
+   beginning. So in this case, "I6 - Document how to create local
+   environment"
+6. Push the changes to **your** repository:
+   ````
+   $ git push upstream
+   ````
+7. Go to your repository online - you will now see an option to create
+   a pull request against the main HPR repository. Click the Create
+   **Pull Request** button and fill out the form.
+
+8. Once the pull request is accepted, you can delete your local branch
+   if you wish.
+
+## Summary
+Using this approach means contributing is straight forward, and
+doesn't require everyone to have write access to the main HPR
+repositories.  Since you are pulling from the origin repositories, you
+will always be working on up to date code.