Meteor-files: Update docs

Created on 17 Jan 2018  路  3Comments  路  Source: veliovgroup/Meteor-Files

Update docs and wikis.

  • Minimize amount of data presented at front page (README.md);
  • Simplify examples presented at front page (README.md);
  • Split wikis (docs) by functionality (a.k.a. API), not tasks (Howtos);
  • Differentiate feature, functionality (API), and tasks (Howtos) docs;

Articles:

  • [ ] Security
  • [ ] Publish / Subscribe
  • [ ] Using files without references and pub/sub (denormalization concepts)

Use flow-router-extra repository as example

Documentation enhancement help wanted

Most helpful comment

Please fix the React examples #750

All 3 comments

Forgive me if maybe this is the wrong thread, just adding it here since I think maybe the Template helper wiki page is out of date(I couldn't get it working by the example but perhaps I made a mistake).
The 'Streaming' section on home page appears to be correct and worked great for me... but the fileURL example gave me trouble when trying to access a sub version of fileRef. For example:

Did not work:
{{fileURL fileRef 'small'}}

Works for me (although not clearly documented), adding the sub version name as argument with the link helper:
{{fileRef.link 'small'}}

Again, sorry if this confuses this thread (Im new here) or I misunderstood something, but thanks VERY much for your hard work , this package is great and Im happy to be free from the shackles of CollectionFS!

Hello @joephuz ,

Im happy to be free from the shackles of CollectionFS!

Sounds awesome, I'm glad this lib helped you :)

Helper works fine for a long time. Let's check why fileURL helper doesn't work for you:

  1. Do you get any errors?
  2. What is the fileRef in your case? Could you console.log it?
  3. Feel free to start a new issue following our issue template

Please fix the React examples #750

Was this page helpful?
0 / 5 - 0 ratings