Skip to content

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

Merged
tlaurion merged 58 commits into
linuxboot:masterfrom
Thrilleratplay:master
Oct 19, 2020
Merged

Add structure to documentation and copy Heads related pages from trmm.net#49
tlaurion merged 58 commits into
linuxboot:masterfrom
Thrilleratplay:master

Conversation

@Thrilleratplay
Copy link
Copy Markdown
Contributor

@Thrilleratplay Thrilleratplay commented Sep 13, 2020

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:

  • Corrected legitimate markdownlint errors. There are a few that remain due to line length in code blocks.
  • moved Slack contact to "community" page
  • About page now begins with overview
  • Copied content of https://trmm.net/Heads_FAQ to "FAQ" under "Brief overview of Heads and firmware security"
  • Copied content of https://trmm.net/Tpmtotp to "tpmtotp" under "Brief overview of Heads and firmware security"
  • Copied content of https://trmm.net/Heads_threat_model to "Heads threat model" under "Brief overview of Heads and firmware security"
  • Updated links mentioned in trmm.net required changes #46 and a few other dead links that were found.

Next steps:

  • Add list of supported devices and required equipment.
    • Explain the differences between different security keys.
  • Break down installation guide with a per device flash tutorial.
  • Update post flash installation to include items mentioned in Document GUI process of generating keys/importing keys with pictures #48
  • Rename or very least stress the "influences" page is more "standing the shoulders of giants", although this idiom may be confusing to those who are not familiar with it especially when the project is named "Heads".
  • Add to FAQ
    • HOTP vs TOTP
    • coreboot vs Linuxboot
    • what happens if I lose/break my security key?
    • Expand on some of the existing questions and examples for clarity.
  • Add similar/related projects to About page

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.

Copy link
Copy Markdown
Collaborator

@tlaurion tlaurion left a comment

Choose a reason for hiding this comment

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

First diagonal read with what jumped in my eyes.
I would strongly suggest to poke @channel under Slack for review.

Comment thread Brief-over-of-Heads-and-firmware-security/FAQ.md Outdated
Comment thread Brief-over-of-Heads-and-firmware-security/FAQ.md Outdated
Comment thread Brief-over-of-Heads-and-firmware-security/FAQ.md Outdated
Comment thread Brief-over-of-Heads-and-firmware-security/Heads-threat-model.md Outdated
Comment thread Brief-over-of-Heads-and-firmware-security/Heads-threat-model.md Outdated
Comment thread Installing-and-Configuring/Building.md Outdated
Comment thread Community.md
Comment thread Installing-and-Configuring/GPG.md Outdated
QR code in your phone by running:

```
```shell
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Seeing all of those outdated shell scripts calls makes me extremely unconfortable.
Do not know what to do with that and source of most of the confusion.

Search in page ".sh"

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Part of the markdownlint is to assign a language to code blocks. These are not shell scripts as much as they are the shell command in the documentation.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

My point here was links to old not even existing shell scripts should be removed

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Oh I see. I haven't started updating the install documents, so these will be removed or corrected.

Comment thread index.md Outdated
@tlaurion
Copy link
Copy Markdown
Collaborator

tlaurion commented Sep 25, 2020

@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
Copy link
Copy Markdown
Contributor Author

@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.

Comment thread Development/Porting.md Outdated
Comment thread Development/Porting.md Outdated
Comment thread Installing-and-Configuring/Building.md Outdated
Comment thread Installing-and-Configuring/install-os.md
Comment thread Installing-and-Configuring/install-os.md Outdated
Comment thread About/Keys.md Outdated
Comment thread Development/Porting.md Outdated
Comment thread Installing-and-Configuring/Building.md Outdated
@tlaurion
Copy link
Copy Markdown
Collaborator

@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:

  • grounding pins (reference missing)
  • WP bits where the links to archive.org articles is the only source I found for experimenters.
    I think each place which speaks about it should point to external doc.

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
Copy link
Copy Markdown
Collaborator

tlaurion commented Oct 14, 2020

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

Comment thread Installing-and-Configuring/Building.md
@Thrilleratplay
Copy link
Copy Markdown
Contributor Author

Thrilleratplay commented Oct 14, 2020

@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 tlaurion merged commit fbcc720 into linuxboot:master Oct 19, 2020
@tlaurion
Copy link
Copy Markdown
Collaborator

@Thrilleratplay : please run url validation!

@Thrilleratplay
Copy link
Copy Markdown
Contributor Author

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

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants