add documentation to repo #1407
Conversation
olamilekan000
commented
Sep 20, 2025
olamilekan000
commented
|
Thanks a lot for this. I actually do not think we need to have a cli command to generate the documentation site. It can be standalone and independent of the colima app itself. |
Like a shell script or binary? |
olamilekan000
force-pushed
the
add-docsy-for-documentation
branch
from
cd892f6 to
5282e2d
Compare
Since it a hugo site, |
That's true. The generate-doc command can be moved there. |
I mean, we don't need to include the command. We may include a makefile target, but nothing more. It is not a big deal, that hugo installation is a requirement for generating the website. |
olamilekan000
force-pushed
the
add-docsy-for-documentation
branch
4 times, most recently
from
89e89e0 to
4afa947
Compare
olamilekan000
force-pushed
the
add-docsy-for-documentation
branch
from
4afa947 to
c4d69c1
Compare
olamilekan000
force-pushed
the
add-docsy-for-documentation
branch
from
c4d69c1 to
f7e1c58
Compare
| - OS: Ubuntu | ||
| - CPU: 2 cores | ||
| - Memory: 2 GiB | ||
| - Disk: 60 GiB |
There was a problem hiding this comment.
| - Disk: 60 GiB | |
| - Disk: 100 GiB |
olamilekan000
force-pushed
the
add-docsy-for-documentation
branch
from
f7e1c58 to
4eac2b2
Compare
Signed-off-by: olalekan odukoya <odukoyaonline@gmail.com>
olamilekan000
force-pushed
the
add-docsy-for-documentation
branch
from
4eac2b2 to
3a20f0e
Compare
|
|
||
| ✅ ARM on ARM | ||
|
|
||
| ✅ Various guest Linux distributions: [AlmaLinux](./templates/almalinux.yaml), [Alpine](./templates/alpine.yaml), [Arch Linux](./templates/archlinux.yaml), [Debian](./templates/debian.yaml), [Fedora](./templates/fedora.yaml), [openSUSE](./templates/opensuse.yaml), [Oracle Linux](./templates/oraclelinux.yaml), [Rocky](./templates/rocky.yaml), [Ubuntu](./templates/ubuntu.yaml) (default), ... |
There was a problem hiding this comment.
This seems to be about Lima, not Colima
|
|
||
| Pull requests require approval from project maintainers before merging. | ||
|
|
||
| Maintainers shouldn't merge their own pull requests without approval from at least one other maintainer. |
| | Configuration | Lima | Colima | | ||
| |--------------------|--------------------------------------------|-----------------------------------| | ||
| | CPUs | `limactl start --cpus=4` | `colima start --cpu=4` | | ||
| | Memory | Complex YAML configuration | `colima start --memory=8` | |
There was a problem hiding this comment.
limactl has also --memory
| @@ -0,0 +1,17 @@ | |||
| # SPDX-FileCopyrightText: Copyright The Colima Authors | |||
There was a problem hiding this comment.
Doesn't seem right to take https://github.com/lima-vm/lima/blob/master/website/Makefile and alter the copyright holder information
| section = ["HTML", "print", "RSS"] | ||
|
|
||
| [params] | ||
| copyright = "Colima Authors" |
There was a problem hiding this comment.
Mostly seems copied from https://github.com/lima-vm/lima/blob/master/website though
There was a problem hiding this comment.
Colima is not a CNCF project
| @@ -0,0 +1,6 @@ | |||
| <section class="text-center"> | |||
| <h4>{{ .Site.Title }} is built on <a class="text-secondary" href="https://github.com/lima-vm/lima">Lima</a>, a <a class="text-secondary" href="https://cncf.io">CNCF</a> sandbox project</h4> | |||
| <section class="text-center"> | ||
| <h4>{{ .Site.Title }} is built on <a class="text-secondary" href="https://github.com/lima-vm/lima">Lima</a>, a <a class="text-secondary" href="https://cncf.io">CNCF</a> sandbox project</h4> | ||
|
|
||
| <img class="cncf-logo" |
|
|
||
| ### Licensing | ||
|
|
||
| Colima is licensed under the terms of [MIT License](https://github.com/abiosoft/colima/blob/main/LICENSE). |
There was a problem hiding this comment.
What about the license of the docs that were mostly copied from Lima ?
There was a problem hiding this comment.
@AkihiroSuda This PR is still in progress, and I was the one who added the PR. I’ll convert it to a draft to avoid confusion and make sure we correctly handle any licensing details from Lima before marking it ready for review.
There was a problem hiding this comment.
Maybe better to write the docs from scratch to avoid confusion and duplicate across the two projects
|
|
||
| ## Key advantages of Colima over raw Lima | ||
|
|
||
| - **Simplified CLI**: Single `colima start` command vs complex Lima templates |
There was a problem hiding this comment.
Lima has a simple limactl start CLI too, and Colima has complex YAML templates too
|
|
||
| - **Simplified CLI**: Single `colima start` command vs complex Lima templates | ||
| - **Docker-first**: Docker works out of the box without configuration | ||
| - **Better defaults**: Optimized for container workloads |
There was a problem hiding this comment.
What is the evaluation function you use to measure "Better"?
| - **Docker-first**: Docker works out of the box without configuration | ||
| - **Better defaults**: Optimized for container workloads | ||
| - **Integrated Kubernetes**: Built-in k3s support with `--kubernetes` flag | ||
| - **Automatic cleanup**: Better resource management and cleanup |
There was a problem hiding this comment.
What is the evaluation function you use to measure "Better"?
What resources are managed and cleaned up ?
| - **Simplified CLI**: Single `colima start` command vs complex Lima templates | ||
| - **Docker-first**: Docker works out of the box without configuration | ||
| - **Better defaults**: Optimized for container workloads | ||
| - **Integrated Kubernetes**: Built-in k3s support with `--kubernetes` flag |
There was a problem hiding this comment.
Integrated to Lima too though
| - **Integrated Kubernetes**: Built-in k3s support with `--kubernetes` flag | ||
| - **Automatic cleanup**: Better resource management and cleanup | ||
|
|
||
| The `colima` CLI provides a more streamlined experience compared to `limactl`: |
There was a problem hiding this comment.
What is "streamlined" ?
| </div> | ||
| </div> | ||
| <div class="row text-center text-white small"> | ||
| <div id="cncf-footer" class="col-12 text-center py-2 order-sm-2"> |
There was a problem hiding this comment.
The footer is misleading for a non-CNCF project
|
I think it would be best to start from scratch to avoid any issues. Thanks for your efforts @olamilekan000. |
3 participants
