Document how to call aliased functions with the AWS SDK

[HyperBrain]

The README should contain a section that shows how to call aliased lambda functions (e.g. setting the Qualifier).

[HyperBrain]

The README keeps growing and is getting confusing over time. I'm looking for a better way to document the plugin. Does anyone have experience with that - e.g. the use of GitHub pages or the Gitub Wiki? The documentation system should allow a structured documentation with a table of contents and links to the different sections.

[mikelax]

Thanks for your work on this plugin.

I found GitHub has their own list of "good" project wikis. Of this list, hystrix and snowplow look nicely organized.

I generally favor putting everything into the readme, but recognize that can get unwieldy for larger doc.

A good compromise might be to have the readme document the basic usage and top 20% of functionality. It could then link to the wiki for full documentation.

[HyperBrain]

Thanks for the suggestions. I had a look at the projects and the general layout of the two project wikis yuo mentioned look quite good (the topic menu at the right side and the organization within the document). The Hystrix project topic/page list on the right is a bit cleaner than the one of snowplow.

I will not "empty" or dismiss the README in favor of the wiki of course 😄. You're absolutely right that the README could contain the basics. That will reduce and restrict its size significantly.

For the more detailed or expert use cases and documentation I could either link the wiki topics from the README (like "see also xxxxx") or reference the whole wiki at the end or beginning of the README.

[justinffs]

https://readthedocs.org/ is also a good and free documentation platform but it is outside of the github ecosystem.