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

Wiki pages not linked from README #516

Open
bannmann opened this issue Nov 30, 2019 · 2 comments
Open

Wiki pages not linked from README #516

bannmann opened this issue Nov 30, 2019 · 2 comments

Comments

@bannmann
Copy link

To simplify the installation of cheat & cheatsheets, I created docker-cheat which packages both projects in a single 9 MB docker image. As it may be useful to others as well, I went ahead and linked the project here - specifically from the 'Related Projects' and 'Installing' wiki pages.

However, I noticed neither page is linked by the README. Is that intentional? For example, I was quite surprised when I read on 'Installing' that there are 'cheat' OS packages, a fact that the README fails to mention.

@chrisallenlane
Copy link
Member

Hi, @bannmann

Thanks for your work on docker-cheat!

Regarding the README situation - yeah, I'm aware that it doesn't link to the wiki currently, and I agree that's not ideal. I've omitted the link because the wiki is a bit of a mess currently. I don't really know what's in there anymore, and there isn't much structure to the content.

I'm going to make a pass through it in the near-term to tidy things up a bit (and add some more information), and I'll create a README link when I'm happy with it.

I'll leave this ticket open until then as a reminder to do so.

@AlJohri
Copy link

AlJohri commented Feb 2, 2020

Thanks @bannmann!! Adding alias cheat='docker run --rm bannmann/docker-cheat' worked great for me as it was batteries included (no config file not found errors, no downloading external cheatsheets, etc.).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants