search

intel / ccc-linux-guest-hardening

Linux Security Hardening for Confidential Compute
https://intel.github.io/ccc-linux-guest-hardening-docs
MIT License
64 stars 13 forks source link

Doc update for the main README.md #73

Closed tz0 closed 1 year ago

tz0 commented 1 year ago

This PR follows the previous PR Doc fix #72 and updates the installation guide and the list of further documentation in the main readme.

One thing we want to decide is what to do with the overlapping area (e.g., installation and activation) between the main readme and the /docs/getting_started.md

tz0 commented 1 year ago

This PR is on top of the PR #72. The first 4 of 5 commits on are exactly same which are the fixes of typos and links across a few docs. Reviewing only the last commit should be sufficient.

il-steffen commented 1 year ago

We can take the intro part from getting_started.md, or we take a shorter / high-level version of it. I would vote for the second option, so that the homepage can have a quick intro while the detailed docs can have more background info/notes.

tz0 commented 1 year ago

We can take the intro part from getting_started.md, or we take a shorter / high-level version of it. I would vote for the second option, so that the homepage can have a quick intro while the detailed docs can have more background info/notes.

I agree with the second option. I can think of two ways to do it:

  1. I remove the installation and activation section from the main readme or make it very brief. And add a "please refer to" link to point to getting_started.md for detail.
  2. I keep the current main readme as is. Add more detail in the the getting_started.md.

I am more inclined to the first way.