jesseduffield / lazydocker

The lazier way to manage everything docker
MIT License
36.48k stars 1.18k forks source link

Make it clear that cheetsheets are auto-generated #369

Closed jesseduffield closed 1 year ago

jesseduffield commented 1 year ago

Is your feature request related to a problem? Please describe. Sometimes somebody will raise a PR making manual changes to a cheatsheet file. These cheatsheet files are actually auto-generated and depend on files in pkg/i18n.

In lazygit we print a message at the top of the cheatsheet saying that it's auto-generated i.e.:

        content = fmt.Sprintf("_This file is auto-generated. To update, make the changes in the "+
            "pkg/i18n directory and then run `%s` from the project root._\n\n%s", CommandToRun(), content)

We should do that here too in https://github.com/jesseduffield/lazydocker/blob/master/scripts/generate_cheatsheet.go

gusandrioli commented 1 year ago

I'll take this one.

jesseduffield commented 1 year ago

@gusandrioli go right ahead :) Let me know if you need any pointers