Improve UI / UX of the install documentation #339

Closed
bnvk opened this Issue Jul 13, 2016 · 5 comments

Comments

Projects
None yet
4 participants
@bnvk

bnvk commented Jul 13, 2016

A few ideas / thoughts I've come across during my process of flashing a device with Copperhead!

  • Add styling to code blocks / commands like fastboot flashing lock
  • Add numbers to each items 1. Prerequisites 2. Enabling OEM unlocking
  • Describe the process once ./flash-all.sh completes what happens next (logos, encrypting device, etc...).
  • Add a Troubleshooting section that talks about a few things that might go awry, if one does not have enough RAM, if one reboots before the device encryption finishes!
@craftyguy

This comment has been minimized.

Show comment Hide comment
@craftyguy

craftyguy Dec 6, 2016

I would take a shot at this if I could find the source for the install documentation on copperhead.co!

I would take a shot at this if I could find the source for the install documentation on copperhead.co!

@thelifeofjay

This comment has been minimized.

Show comment Hide comment
@thelifeofjay

thelifeofjay Dec 6, 2016

Contributor

@craftyguy I'll send you some information via email

Contributor

thelifeofjay commented Dec 6, 2016

@craftyguy I'll send you some information via email

@thelifeofjay

This comment has been minimized.

Show comment Hide comment
@thelifeofjay

thelifeofjay Dec 6, 2016

Contributor

@bnvk still awaiting your acceptance and review

Contributor

thelifeofjay commented Dec 6, 2016

@bnvk still awaiting your acceptance and review

@bnvk

This comment has been minimized.

Show comment Hide comment
@bnvk

bnvk Dec 14, 2016

bnvk commented Dec 14, 2016

@thestinger thestinger changed the title from Improve UI / UX of the install documentaiton to Improve UI / UX of the install documentation Jul 7, 2017

@thestinger

This comment has been minimized.

Show comment Hide comment
@thestinger

thestinger Jul 31, 2017

Contributor

There have been some minor improvements to the installation guide over time and it's simpler now that the special cases for the Nexus 9 are gone (lacks full verified boot, uses fastboot oem unlock instead of the newer fastboot flashing unlock, etc.).

Issues involving styling beyond changes in pure markdown are a broader problem requiring a rewrite of the site. It doesn't make sense to keep building on the current broken foundation. It wasn't made in a maintainable / robust way so only the markdown content is important and worth working on. The rest needs to be thrown out and done from scratch, which isn't in the scope of documentation.

I don't think improving it is going to be a priority with Nexus devices on the way out. September 2018 is the end-of-life for the Nexus 5X and 6P at which point CopperheadOS will only be available as sources and preloaded devices unless something changes before then. The old model didn't work and I'm not able to keep maintaining the OS all on my own especially without being properly compensated for it which still isn't the case. We need to do everything we can to boost sales and not giving away official builds for free is definitely having a significant positive impact on that. I don't think enough people are building from source for that to have a significant negative impact, although you'd think that with ~30 people doing it we'd have gotten a contribution of code to the OS by now but nope - only the PDF Viewer app.

Contributor

thestinger commented Jul 31, 2017

There have been some minor improvements to the installation guide over time and it's simpler now that the special cases for the Nexus 9 are gone (lacks full verified boot, uses fastboot oem unlock instead of the newer fastboot flashing unlock, etc.).

Issues involving styling beyond changes in pure markdown are a broader problem requiring a rewrite of the site. It doesn't make sense to keep building on the current broken foundation. It wasn't made in a maintainable / robust way so only the markdown content is important and worth working on. The rest needs to be thrown out and done from scratch, which isn't in the scope of documentation.

I don't think improving it is going to be a priority with Nexus devices on the way out. September 2018 is the end-of-life for the Nexus 5X and 6P at which point CopperheadOS will only be available as sources and preloaded devices unless something changes before then. The old model didn't work and I'm not able to keep maintaining the OS all on my own especially without being properly compensated for it which still isn't the case. We need to do everything we can to boost sales and not giving away official builds for free is definitely having a significant positive impact on that. I don't think enough people are building from source for that to have a significant negative impact, although you'd think that with ~30 people doing it we'd have gotten a contribution of code to the OS by now but nope - only the PDF Viewer app.

@thestinger thestinger closed this Jul 31, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment