Skip to content

Thoughts

Jonah edited this page Nov 21, 2017 · 1 revision

General

Main features

Creatings gists from files

User should be able to create gists from one or multiple files

Listing created gists

User should be able to list gists created from files

Should we display:

  • Gist name
  • Gist description
  • Gist creation date
  • Gist version
  • Gist creator
  • Gist comments #
  • Gist publicity
  • Gist type
  • Gist size
  • Gist id
  • Gist change status
  • Gist url

Pulling created gists

User should be able to pull gists created from files

Deleting creating gists

User should be able to delete gists created from files

Local database

The module should keep at local database of gists created from files

Optional features

Remote database

  • Should there be some kind of way to keep a remote database of created gists?
  • Should a login be required?

Use something else than gists

  • Are gists the best idea for this?
  • Alternatives?
  • What if the user wants to save images or something else than code - can gists do that?

Temporary pulling

What if the user doesn't need the whole file, but knowns there is, for example, a single function within that file that needs to be copied? We could implement gistr tmppull that automatically removes the pulled gist after a while through zombie process or we could implement gistr removelatest, which locally removes the latest pulled file.

Updating gists

  • Should the user be able to update gists created from files?
  • Should we keep track of gist versions?

Analytics

  • Is the user interested in, say, usage statistics?

Possible analytics:

  • Created gists
  • Removed gists
  • Pulled gists

Import / Export

  • Should the user be able to easily export the local database of created gists?
  • Should the user be able to easily import a local database of created gists?

Problems

Gists

  • Are gists rate-limited somehow?
  • Should we take care of limiting spam-requests to Github or leave that to Github?

Security

  • Should we be worried about others being able to access gists created by some user?
  • Gists can be anonymous and secret, but is that safe enough?