Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README.md - fixes and updates #683

Merged
merged 3 commits into from
Oct 18, 2021
Merged

README.md - fixes and updates #683

merged 3 commits into from
Oct 18, 2021

Conversation

EricClaeys
Copy link
Collaborator

Added remaining settings, references the Wiki when needed, moved some text to the Wiki to shorten the file, reworded some setting descriptions for clarity.

Added remaining settings, references the Wiki when needed, moved some text to the Wiki to shorten the file, reworded some setting descriptions for clarity.
@EricClaeys EricClaeys added bug needs software change config labels Oct 18, 2021
Copy link
Collaborator

@ckuethe ckuethe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's too late for me to read more carefully, so here are some thoughts. In general, I'd suggest that we actually link to the wiki instead of making a general reference to it.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
@ckuethe ckuethe merged commit 950d9bb into master Oct 18, 2021
@EricClaeys
Copy link
Collaborator Author

@ckuethe, I agree 1000% about the 3rd party links. In face, I think we should remove them and instead beef up our documentation. Not sure I want to make a video, but screenshots would be useful.

I added both your comments to the Project dealing with updates to README.md.

@csb0xc4rs
Copy link

Hey there, Chad (Patriot Astro) here. Funny timing. I had just sent Thomas a message about this. Here is the majority of that message (below) just to give you some insight into what I am doing and the analytics about how often the videos are being used. Anyway, I will be updating the video in a modular format so it is far easier to keep updated on my end. Also of course, calling out the project page, discussions, QA, wiki, etc as the source of truth (at the beginning of the video). Certainly your call on linking or not, but I thought I would let you know what is already in the works on my end (plus analytics visibility).
He mentioned getting in touch with you, so here you go. :)

I just checked the video analytics and wanted to share some quick analytics with you. My allsky part 1 video is still getting 60-100 views PER DAY (the other 2 related videos are getting maybe 20-25 each per day on top of that) Typical watch time is about 10 minutes, which is VERY high for a 21 minute video. Seems like many people come and start the video, then tag it to watch when the hardware comes in, then watch the whole thing. Basically, this tells me people are watching the video tutorial AND they are likely watching it while they do it themselves. I know the Wiki is progressing, but I think lots of people are just “watch and do” not “read and research” people. ☺

So, here are my thoughts about producing a new video:

Part 1 – Intro

  • Intro to the project
  • Cover the GitHub page usage
  • Drive home the support aspect
  • Point to the Wiki
  • Drive Donations
  • Remind people to always check for latest content, updates, instructions

Part 2 – Pi Hardware

  • Cover pi hardware build

Part 3 – Raspbian and OS Prep

  • Cover Raspbian install and base OS prep

Part 4 – Allsky Install

  • Cover current allsky walkthrough mentioning date it was products
  • Cover common configuration, etc

Part 5 – Usage

  • Illustrate basic usage

I’ve learned a lot over the last year about video production and the above framework will allow me to replace the video whenever needed by rip/replace the parts that need updating. New allsky changes, replace that part and re-publish the video. New pi hardware, same rip/replace process. I also want to be sure that the beginning of the video calls out the most critical points right away.

Anyway, I hope to have this out in a week or so. I’ll let you know when it is ready in case you want to use it. Of course that is up to you whether or not it is referenced by your project, but I think there may be big value to the visual learners (of which there are many apparently).

@ckuethe
Copy link
Collaborator

ckuethe commented Oct 18, 2021

That's great to hear that you're interested in keeping the video up to date. I do recognize some people prefer a visual walkthrough, and if you're maintaining its accuracy then it'll be a really great resource. I was mostly concerned about stale content but that sounds like you're on top of this.

@EricClaeys EricClaeys deleted the README.md-updates branch October 19, 2021 00:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug needs software change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants