Browse Source

added generated doc pages

Harlan Iverson 7 years ago
parent
commit
9c2d288d57

+ 73 - 0
app/resources/templates/md/pages/doc-CONTRIBUTING.md

@@ -0,0 +1,73 @@
+{:layout :page
+ :title "Doc: CONTRIBUTING"
+ :page-index 4000
+ :navbar? false
+ :generated-at 1526529251
+ :last-modified 1526522778
+ }
+
+# Contributing to iSpooge Live
+
+iSpooge Live is a project aims to allow sovereigns to have a platform that plays 
+well with others. This philosophy is reflected in our contributor guidelines. 
+Thanks for considering helping us out.
+
+
+## The lowdown
+
+This project is a personal mission. I'm working toward a 1.0 release 
+and have a development track that I want to lay down.
+
+I want to share the project free, so it's MIT licensed. I may join
+the social works later. I am happy for communities to develop without
+my participation, am open to invitations.
+
+## Important artifacts
+
+* README.md -- developer documentation
+* doc/ -- creator documentation
+  * ROADMAP.md -- spoiler: we choose none
+  * PERSONAS.md -- friends who think about iSpooge Live
+  * THANKS.md -- contributors
+  * operations.md --
+  * features.md --
+  * glossary.md -- 
+
+
+## Communication
+
+We assume an 8th grade level English proficiency. Translators welcome.
+
+* https://www.flocabulary.com/8th-grade-vocabulary-word-list/
+* https://www.flocabulary.com/wordlists/
+
+### Philosophy
+
+* Start with similarities.
+* Show, don't tell--we prefer to communicate via repo activity RSS feeds.
+* Focus on what's been done, connections--avoid speculation and wishing.
+* Time is the enemy, ideas are cheap. (opportunity is where the value is).
+
+eg. I see virtue 1,2,3 of that approach, but based on X,Y,Z I think this approach 
+has merit; check out exhibits A and B.
+
+### Making changes
+
+* Please do not submit pull requests--we'll find your changes if we want them.
+* Emails with a pointer to your repo and proposal to move forward are welcome (expect days of delay).
+* You've already forked off, so we don't need to do anything if we disagree.
+
+### Reporting bugs
+
+We use the Eisenhower Matrix approach to classification:
+
+* Important/Not - This is required for something that should work, eg. regressions
+* Urgent/Not - This is required for something that needs to work NOW, eg. broken builds/blockers.
+
+Please provide your best estimate for time and approach we should use to fix. Often
+times this will lead to contributing a fix. Being "non-technical" is not reasonable.
+
+## Recognition
+
+* THANKS.md -- add your name when you fork, it'll make it in. I'll add you if we talk.
+

+ 86 - 0
app/resources/templates/md/pages/doc-PERSONAS.md

@@ -0,0 +1,86 @@
+{:layout :page
+ :title "Doc: PERSONAS"
+ :page-index 4006
+ :navbar? false
+ :generated-at 1526529252
+ :last-modified 1525810988
+ }
+
+# Personas who may use the system.
+
+# Phil
+
+Phil loves to share his life but there aren't many nearby people who understand him. He's 
+generally happy but being a social human has a desire for acceptance and a 
+need for feedback. High definition audio and video equiment can help him in his 
+reflection process, and a small IT system can help him build an online audience 
+and find his place in the world among new friends.
+
+He works a job and isn't particularly happy or unhappy with it. The hours are usually
+regular but sometimes he needs to clean up a mess. He'd leave but has reasons to 
+remain comfortable, but is increasingly unsatisfied with his rationalizations.
+His new friends are a great asset, he wishes to maintain contact with them and 
+is exhausted from the ever-changing social network du jour and thinks perhaps 
+he can build a system that works for him.
+
+He's really happy that a former Silicon Valley software engineer hammered 
+together a boilerplate that he found in a ranting comment on Hacker News </fantasy>.
+
+* Phil is a vlogger *
+
+# Beth
+
+Beth has been uploading her videos to YouTube for quite a while. She's live streamed
+a few times recently but unfortunately she received a copyright strike for reviewing a movie 
+with a clip of licensed background music, and her fair use appeal was denied. She's 
+happy to remake the review with a different section of video to remain in compliance,
+but the live stream ban has hurt her new business plan.
+
+Because she doesn't want to wait for live stream access to be re-enabled, she looked
+around for an alternative solution and found iSpooge Live, with ready made
+scripts to help her migrate all of her videos and playlists. It took her a little banging,
+but she finally got it online. She's good with math and unafraid to get her hands 
+a little dirty with a free software project; they all say code is math, right? (hahaha).
+
+She starts changing the style of the project to meet her preferences and will in time 
+want to customize the video player, perhaps incorporating promoted content from her
+sponsors.
+
+* Beth is a YouTuber *
+
+
+# Steve
+
+Steve loves to code. It's his escape and passion. He codes at work, he codes at 
+home when he has energy and time. He games a little, but has a dedicated box for that.
+He makes good money, in fact wishes to minimize her personal need for it and 
+contribute to others. He doesn't know it, but contributing brings such rewards 
+to his life that he'll never be in want of materials. He's got a few friends,
+and would love to buy his own place and focus on hacking but was raised without 
+a strong leader in his household, and so only ever learned to be an employee.
+
+He's got the tech skills to do whatever he dreams, and people recognize that. They 
+request his services for their own ends, and for much of his life he has fulfilled 
+and request given to him.
+
+
+* Steve is a passionate programmer *
+
+
+
+# Auntie
+
+Auntie has the trove of family photos and videos on various medium. She's experimented 
+with cloud providers but had some bad experiences. She's savvy enough to keep 
+media in a cool dry place, but doesn't consider that they degrade and need special 
+care given for archiving. Additionally, each family gathering people wish for copies but it's 
+combersome and in some cases she has no device to read the media with the goods 
+on it.
+
+She enlists the help of her nephew to help find a solution to these 
+mounting and recurring issues. She wants something easy to use, maintainable--
+she can change her own oil for example, but perfers to not to. She'll pay a 
+nominal fee for things when a family member can't help her out, and has the mindset
+of keeping resources in the family when possible.
+
+* Auntie is a family matriarch *

+ 14 - 0
app/resources/templates/md/pages/doc-ROADMAP.md

@@ -0,0 +1,14 @@
+{:layout :page
+ :title "Doc: ROADMAP"
+ :page-index 4004
+ :navbar? false
+ :generated-at 1526529251
+ :last-modified 1525805942
+ }
+
+We consciously do not have a roadmap. 
+
+If you have a great idea then fork and we'll watch and pull.
+
+This is in line with our unmediated approach to collaboration and assumption of 
+sovereignty and personal responsibility (our rights are others' responsibilities).

+ 22 - 0
app/resources/templates/md/pages/doc-THANKS.md

@@ -0,0 +1,22 @@
+{:layout :page
+ :title "Doc: THANKS"
+ :page-index 4005
+ :navbar? false
+ :generated-at 1526529252
+ :last-modified 1526420298
+ }
+
+# Thanks
+
+Many thanks are owed for the existence of this project.
+If you enjoy this project, please pay it forward!
+
+* The giants whose shoulders we stand on--free software community
+* Harlan Iverson - original creator
+* Martin Iverson - material support of initial development
+* David Taylor - material support of initial development
+* James Greene - material support of initial development
+* Aaron Lang - material support of initial development
+* Michael Haselton - material support of initial development
+* Matthew Harrison - material support of initial development
+* iSpooge Daily followers - ideas, entertainment

+ 3 - 3
app/resources/templates/md/pages/doc-features.md

@@ -1,8 +1,8 @@
 {:layout :page
  :title "Doc: features"
- :page-index 4001
- :navbar? true
- :generated-at 1526528884
+ :page-index 4002
+ :navbar? false
+ :generated-at 1526529251
  :last-modified 1526522869
  }
 

+ 3 - 3
app/resources/templates/md/pages/doc-glossary.md

@@ -1,8 +1,8 @@
 {:layout :page
  :title "Doc: glossary"
- :page-index 4000
- :navbar? true
- :generated-at 1526528884
+ :page-index 4001
+ :navbar? false
+ :generated-at 1526529251
  :last-modified 1526522823
  }
 

+ 3 - 3
app/resources/templates/md/pages/doc-operations.md

@@ -1,8 +1,8 @@
 {:layout :page
  :title "Doc: operations"
- :page-index 4002
- :navbar? true
- :generated-at 1526528885
+ :page-index 4003
+ :navbar? false
+ :generated-at 1526529251
  :last-modified 1526513584
  }