linuxboot / heads-wiki

Documentation for the Heads firmware project
85 stars 44 forks source link

Add structure to documentation and copy Heads related pages from trmm.net #49

Closed Thrilleratplay closed 4 years ago

Thrilleratplay commented 4 years ago

Changes can be viewed here: https://thrilleratplay.github.io/heads-wiki/

At this point, I am mainly looking at feed back on the current changes and if the next steps are where these changes should be going.

Currently done:

Next steps:

I feel like the different Heads related copied from trmm.net could use some clean up. Links are dying and dated 2015, 2016; including newer examples over the years to show this is still a continuous problem. Additionally, links to the wayback machine should be kept to an absolute minimum. Overall, they should be reworded to have a sense of cohesion within the wiki instead of feeling like they were copied from another site. @osresearch, as these are your words, would you be ok with this? Obviously they could also link to the original pages.

tlaurion commented 4 years ago

@Thrilleratplay Excellent!!!!

Saw that porting guide was also totally off and not covering board pointing to coreboot (bot needs to be unique per board) and board pointing to linux config (can be shared)

Please tag my name when you need review. I agree with all proposed changes here.

Thrilleratplay commented 4 years ago

@tlaurion Thanks for the encouragement but I still have quite a bit of work do for everything to blend together. I have been finding a lot of information is various Heads issue discussions. Any questions I have, I'll ask the slack channel. I will tag you as well as asking the channel again to review when ready.

tlaurion commented 4 years ago

@Thrilleratplay I will review page by page and comment in actual proposed changes. Awesome work, really really welcome.

Thrilleratplay commented 4 years ago

@tlaurion Thank you. I am not a technical writer and I know there is still a lot of work that needs to be done with various parts that are not clear or lacking detail. In my view, this is more of a restructuring to hopefully make it easier for others to make small contributions and step closer to complete wiki. It should be pointed out, I did not change much with the flashing and build parts of the wiki; these seem like they could be radically simplified with some of the changes being proposed.

Any changes you want, I will make. At this stage, I feel like I need to become more familiar with the inner workings of of Heads before I know what is missing from the wiki.

tlaurion commented 4 years ago

@Thrilleratplay The only think I see missing is linked to small misunderstanding about WP bits that should be linked for advenaced users to experiment from, not state it as working.

Heads-wiki refers to:

I'm really happy with the status of this PR. Would love others to read through and have linked a lot of Heads users to this PR and your staging website, but no comment on this PR came out of it. Could let it sit until Friday and then merge?

@osresearch: you ok with those mods?

tlaurion commented 4 years ago

@Thrilleratplay : Sorry to be so validating.... Please take a look at broken links here

Thrilleratplay commented 4 years ago

@Thrilleratplay : Sorry to be so validating.... Please take a look at broken links here

@tlaurion Many of the bad links are due to how Jekyll's generates them. Many of the edit links are pointing to https://github.com/osresearch/heads-wiki/edit/master/ for pages that do not exist but will exist after this has been merged. Another catch 22 are pages that would link correctly when on osresearch.net but will not on https://thrilleratplay.github.io/heads-wiki/ as the root url path; this can be adjusted in the _config.yml but by correcting it in the PR page, it will break when merged in. There are a number of links I can update/correct and will do so.

tlaurion commented 4 years ago

@Thrilleratplay : please run url validation!

Thrilleratplay commented 4 years ago

@tlaurion I did and need to fix a few things. I should have another PR to correct these within the hour.