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

Fix Kata github docs link and update distro wording #180

Open
jodh-intel opened this issue Mar 28, 2022 · 0 comments
Open

Fix Kata github docs link and update distro wording #180

jodh-intel opened this issue Mar 28, 2022 · 0 comments

Comments

@jodh-intel
Copy link
Contributor

As reported by @grahamwhaley here, the software page links to the wrong documentation. The page that needs updating seems to be:

This is the minimal fix fwics (but see below):

diff --git a/src/pages/software/index.md b/src/pages/software/index.md
index 0fc1b65..d4152c1 100644
--- a/src/pages/software/index.md
+++ b/src/pages/software/index.md
@@ -28,7 +28,7 @@ architecture:
       linkText: Go to Git Repository
       title: Get Kata Containers
     - icon: /img/document_primary-dark.svg
-      link: 'https://github.com/kata-containers/documentation'
+      link: 'https://github.com/kata-containers/kata-containers/tree/main/docs'
       linkText: Get Started
       title: View the Documentation
   image: /img/[email protected]
@@ -69,7 +69,7 @@ determine if your host system is capable of running a Kata Container. [Learn how
     <div class="box is-primary-blue">
       <h4 class="box-title">Distributions</h4>
       <div class="box-entry">
-        Kata Containers is available on many distributions. View the [distro specific install guides](https://github.com/kata-containers/documentation/tree/master/install) for: <br />
+        Kata Containers is available on many distributions. View the [distro specific install guides](https://github.com/kata-containers/kata-containers/tree/main/docs/install) for: <br />
         <div class="columns">
           <div class="column">
             <ul>

However, the list of distributions is going to confuse users imho. We used to have separate install guides for each distro, but we don't do that any more so I would be tempted to remove the list of distributions on that page so that it says something like this:

Kata Containers is available on many distributions. See the installation documentation for further details.

/cc @iamweswilson, @SunnyCai1.

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

No branches or pull requests

1 participant