linchpin icon indicating copy to clipboard operation
linchpin copied to clipboard

Reference to examples in documentation

Open abraverm opened this issue 5 years ago • 2 comments

There are many examples but only few are referenced in the documentation. It would be helpful if there would be a documentation page with all the examples and their descriptions and maybe tags (provider\topic). It also would be helpful if relevant pages (i.e providers) will have reference to examples. I believe this can be autogenerated with sphinx and ReST, maybe it will require additional plugin and updating the examples.

abraverm avatar Jul 15 '19 11:07 abraverm

The examples are not listed in the documentation and the PR 1355 didn't fix it. Also that part of documentation is not "examples" but definition of how providers are called. Last, Azure will not be listed in the list of providers (and this is not related to this issue): https://github.com/JunqiZhang0/linchpin/blob/dea6558aad45932820c2b64f6f5db619074dfa4a/docs/source/providers.rst

abraverm avatar Oct 23 '19 08:10 abraverm

@samvarankashyap This issue will likely be partially resolved by the documentation improvements and the move to Molecule testing. We need to determine whether we really need all of the integration testing scenarios in the docs at that point or if they're just dead code

14rcole avatar Mar 31 '20 15:03 14rcole