Clean up S3 documentation #1225

Closed
rnicholus opened this Issue Jun 4, 2014 · 5 comments

Projects

None yet

2 participants

@rnicholus
Member

The Fine Uploader S3 documentation currently lives in the blog. This is a bad place for technical documentation that discusses the API and provides code examples, especially for a complex, detailed, and ever-evolving like S3 support.

I realized that this kind of documentation belongs in the blog even before the Azure module was developed. We should re-organize the S3 feature documentation, following the Azure model. For example, the high-level commentary on Fine Uploader S3 can stay in the blog, along with the step-by-step setup of buckets, IAM users, etc. However, code examples, API details, etc, should be moved onto the docs site S3 feature page. This way, as the API and features related to S3 change, we can be sure that the corresponding S3 feature documentation is versioned alongside the code as well.

@rnicholus rnicholus added this to the 5.1 milestone Jun 4, 2014
@rnicholus
Member

@feltnerm I added this to the 5.1 milestone. I think this is important to get a handle on this soon. Let's discuss and SP tomorrow.

@rnicholus rnicholus changed the title from Clean up S3 documentation to 3 - Clean up S3 documentation Jun 4, 2014
@feltnerm
Member
feltnerm commented Jun 4, 2014

It seems like all the stuff under client-side integration would fall under that category (in the docs) whilst (almost) everything else looks like it can exist in the blog

@rnicholus rnicholus modified the milestone: 5.2.0, 5.1.0 Dec 18, 2014
@rnicholus
Member

pushed to 5.2

@rnicholus rnicholus modified the milestone: 5.3.0, 5.2.0 Mar 24, 2015
@rnicholus
Member

This will hopefully happen as part of 5.3 along with a rewrite of the getting started guide.

@rnicholus rnicholus modified the milestone: 5.3.0, 5.4.0 Jul 6, 2015
@rnicholus rnicholus changed the title from 3 - Clean up S3 documentation to Clean up S3 documentation Oct 29, 2015
@rnicholus
Member

I think the docs will simply have to evolve into the docs site over time.

@rnicholus rnicholus closed this Nov 5, 2015
@rnicholus rnicholus added won't fix/implement and removed 2 - Do labels Nov 5, 2015
@rnicholus rnicholus removed this from the 5.4.0 milestone Nov 5, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment