Code Monkey home page Code Monkey logo

zipline-docs's Introduction

Zipline docs v3

Documentation for Zipline!

Contributing

Do not make PRs to the prod branch, your PR will get closed. Instead, make PRs to the trunk branch, which will be merged into prod when the next Zipline release is made, or whenever I want to. By default, PRs will be made to the trunk branch as it's the default branch.

zipline-docs's People

Contributors

bradym avatar diced avatar ithundxr avatar karpaterna avatar maximmax42 avatar tacticaltechjay avatar wraithy avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

zipline-docs's Issues

Documentation Inaccuracies

As requested, while making a wrapper for the API, I noted everything that was inaccurate or confusing on the docs. The list is as follows:

  • "originalName" present in File model docs but not in responses
  • Folder type not documented in Models
  • createdById missing from Invite model
  • /api/user/urls id type is inconsistent
  • 'gfycat' format specifier doesn't work when uploading files.
  • POST /api/auth/invite does not return a full Invite, only 'code', 'createdById', and 'expiresAt'
  • Files uploaded via the api seem to lose their 'Original-Name' header value.
  • DELETE /api/user/files constantly returning 500 (Could be something on my end, but with how the docs are written my logic should work).
  • DELETE /api/user/urls does not return what is documented.
  • /api/user/folders doesn't seem to respect a false 'files' param, returns with files anyways unless it's left out.
  • /api/upload 'Expires-At' says an iso format date time is invalid, while the same date works while creating an invite.

Note: This list may be incomplete, however these are the ones that I remembered to write down.

Dark theme bad

The dark theme toggle doesn't dark themify the alert to star zipline on github. It's pretty bad design and makes me went to unstar zipline.

database.url syntax clarity

This might help inexperienced people like me when setting up zipline.

In the Database Config section of the docs, examples are given for various database urls. To me it was confusing to see user, password and database all being referred to as 'zipline'. I figured it out with some trial and error but could've saved some time at this step.

Original:

// for postgresql
'postgres://zipline:zipline@localhost:5432/zipline'

// for mysql
'mysql://zipline:zipline@localhost:3306/zipline'

// for sqlite
'file:zipline.db'

My suggestion:

// for postgresql
'postgres://user:password@localhost:5432/database'

// for mysql
'mysql://user:password@localhost:3306/database'

// for sqlite
'file:zipline.db'

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.