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

Update Docs #49

Open
wants to merge 10 commits into
base: main
Choose a base branch
from

Commits on Nov 12, 2024

  1. docs: new structure for docs

    Rethink the structure of the docs as something that will be more useful
    to users. As such, get rid of outdated internal details on guest
    components, kata, and CAA.
    
    This commit leaves many of these new sections mostly empty. They will be
    extended in future commits.
    
    Signed-off-by: Tobin Feldman-Fitzthum <[email protected]>
    fitzthum committed Nov 12, 2024
    Configuration menu
    Copy the full SHA
    b6ee3c9 View commit details
    Browse the repository at this point in the history
  2. docs: add getting-started guide

    Platform-specific setup will be added separately.
    
    Sample workload guide will be simplified with tabbed codeboxes.
    
    Signed-off-by: Tobin Feldman-Fitzthum <[email protected]>
    fitzthum committed Nov 12, 2024
    Configuration menu
    Copy the full SHA
    cfead0d View commit details
    Browse the repository at this point in the history

Commits on Nov 13, 2024

  1. docs: use tabbed codeboxes in installation guide

    This is a much cleaner way to handle the configurations
    for different platforms.
    
    Signed-off-by: Tobin Feldman-Fitzthum <[email protected]>
    fitzthum committed Nov 13, 2024
    Configuration menu
    Copy the full SHA
    b03a579 View commit details
    Browse the repository at this point in the history
  2. docs: improve overview page

    Add an overview of the hw that we support.
    This might be too much information for the top page,
    but at least it gives poeple a sense that the project
    has a broad scope.
    
    We can consider creating a separate hw section later.
    
    Signed-off-by: Tobin Feldman-Fitzthum <[email protected]>
    fitzthum committed Nov 13, 2024
    Configuration menu
    Copy the full SHA
    fc97957 View commit details
    Browse the repository at this point in the history
  3. docs: add troubleshooting guide from github

    Add our existing trouble-shooting guide to the website.
    
    There are some improvements we could make to this doc,
    but for now let's just get it on the website
    
    Signed-off-by: Tobin Feldman-Fitzthum <[email protected]>
    fitzthum committed Nov 13, 2024
    Configuration menu
    Copy the full SHA
    8d26e92 View commit details
    Browse the repository at this point in the history
  4. docs: add placeholder sections for registries

    Let's get all of our features outlined before we add
    detailed material for each.
    
    Here we add authenticated registries and local registries.
    
    Signed-off-by: Tobin Feldman-Fitzthum <[email protected]>
    fitzthum committed Nov 13, 2024
    Configuration menu
    Copy the full SHA
    c34707c View commit details
    Browse the repository at this point in the history
  5. docs: add contributor guide

    Move contributor guide to website.
    
    The website is mostly aimed at users, but our contributor guide
    is pretty good, so let's put it up here.
    
    Signed-off-by: Tobin Feldman-Fitzthum <[email protected]>
    fitzthum committed Nov 13, 2024
    Configuration menu
    Copy the full SHA
    baee520 View commit details
    Browse the repository at this point in the history

Commits on Nov 14, 2024

  1. docs: add design overview

    This is mostly new content covering the design of CoCo.
    
    Signed-off-by: Tobin Feldman-Fitzthum <[email protected]>
    fitzthum committed Nov 14, 2024
    Configuration menu
    Copy the full SHA
    3ee83e9 View commit details
    Browse the repository at this point in the history

Commits on Nov 15, 2024

  1. docs: add use cases section

    Placeholder with some common use cases.
    
    Update with content later
    
    Signed-off-by: Tobin Feldman-Fitzthum <[email protected]>
    fitzthum committed Nov 15, 2024
    Configuration menu
    Copy the full SHA
    5a88e17 View commit details
    Browse the repository at this point in the history
  2. docs: update trust model

    Remove incomplete threat vectors page.
    We can add this back once there is some content,
    but I don't quite see how it fits.
    
    Rename personas to cloud-native-personas.
    
    Update main trust model document to include a plain description
    of the trust model rather a more generic definition of a trust model
    and goals for the trust model.
    
    The new text is mainly an overview. We may want to add something
    more empirical in the future, but this should help users understand
    what's going on.
    
    Signed-off-by: Tobin Feldman-Fitzthum <[email protected]>
    fitzthum committed Nov 15, 2024
    Configuration menu
    Copy the full SHA
    702efa4 View commit details
    Browse the repository at this point in the history