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

Web site (https://lima-vm.io/): migrate to docsy, mkdocs, gitbook, or something else #1499

Closed
AkihiroSuda opened this issue Apr 15, 2023 · 4 comments · Fixed by #1754
Closed
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@AkihiroSuda
Copy link
Member

The https://lima-vm.io/ website just (poorly) renders markdown on the client side.
We should consider migrating the website to docsy, mkdocs, gitbook, or something else.

Requirements

  • The site SHOULD be multi-versioned (v0.15.x, v0.16.x, master, ...)

  • The site MAY support multiple languages, but its maintenance cost will be probably high. Just linking to a machine translation site might be enough.

  • The site MUST have the limactl CLI reference

  • The site MUST have the built-in template list. Just linking to https://github.com/lima-vm/lima/blob/master/examples/README.md might be enough.

  • The site SHOULD have the YAML reference

Resources

Netlify base directory: https://github.com/lima-vm/lima/tree/master/website

@AkihiroSuda AkihiroSuda added documentation Improvements or additions to documentation help wanted Extra attention is needed good first issue Good for newcomers and removed good first issue Good for newcomers labels Apr 15, 2023
@afbjorklund
Copy link
Member

afbjorklund commented Apr 15, 2023

Would it be a good idea to keep the web site out of the lima code repository ?

The monorepo can quickly get out of hand, like it did for minikube (with hugo)

https://github.com/kubernetes/minikube/tree/master/site

333M	.git/modules/site/themes/docsy/

@AkihiroSuda
Copy link
Member Author

AkihiroSuda commented Apr 15, 2023

Would it be a good idea to keep the web site out of the lima code repository ?

I'd prefer monorepo

333M .git/modules/site/themes/docsy/

I guess we should only have the actual contents in the lima repo.
The theme files can be fetched in netlify.toml.

@balajiv113
Copy link
Member

I will work on this .. Will try to provide some basic website within this week

@afbjorklund
Copy link
Member

afbjorklund commented Aug 17, 2023

The Podman Desktop team added a "white" version of the logo, for use on black backgrounds (for the "dark mode")

black (light)

white (dark)

We probably want to add at least the SVG version of it to the repository, for use in:

https://github.com/cncf/artwork/blob/master/examples/sandbox.md#lima-logos

I rendered some higher resolution PNG, but for the code repo that just adds bloat.

So far there is no movement on the icon situation, but then again it is probably not needed for the website either...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants