chubin/cheat.sh

Cascading cheat sheets

Open

#98 opened on Aug 12, 2018

View on GitHub
 (33 comments) (3 reactions) (1 assignee)Python (40,278 stars) (1,876 forks)batch import
enhancementhelp wantedimportant

Description

With our "cascading cheat sheets" mode (it will be described in README.md soon), you can create a hierarchy of cheat sheets servers, where each server delivers local cheat sheets + if a requested cheat sheet is not found, the query is forwarded to the upstream server (and so on).

cheat.sh
    ^
    |
cheat.my
    ^
    |
clients

For the user it looks fully transparent, it uses the same clients as always. The only difference is that the clients should be configured the correct server (is some clients are used; of course, if you use nothing but curl, you change nothing but the name of the server in the query):

curl cheat.my/secret

In this query, you ask the cheat.my server for the secret cheat sheet.

The main advantage of this mode is that you can have your own (private or maybe public but relevant only to you and to your team) cheat sheets, and at the same time, you can use the global cheat sheets to, without changing anything.

This issue is related to #5, #14, #97

To do:

  • server side implementation
  • cheat.sh docker container (almost implemented by @bglopez)
  • documentation (README.md)
  • cht.sh client custom server support
  • cheat.sh-vim custom server support (@dbeniamine)
  • vscode-snippet custom server support (@mre)
  • cheat-sh.el custom server support (@davep)
  • cheat.sh-sublime-plugin custom server support (@gauravk-in)
  • windows client custom server support (@tpanj )

Contributor guide

Tech stack
pythonshelldocker
Domain
backendapi
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Python programmingHTTP server basicsDocker
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
Review existing implementations of cheat.sh server and client plugins (e.g., cht.sh, vim emulator). Understand the current request forwarding mechanism. The subtasks for server side implementation and Docker container (initiated by @bglopez) need to be completed. Check issues #5, #14, #97 for related discussions. Then design a modular way to handle upstream forwarding and add configuration for cascading hierarchy.
Cascading cheat sheets · chubin/cheat.sh#98 | Good First Issue