Fn FDK Documentation Guidelines

When developing documentation for the Fn FDKs, what documentation goes into the FDK repo and what goes into the general docs repo?

Docs on FDK Development - FDK Repo

Docs stored here should cover how to develop an FDK for Fn. Any articles, tutorials, examples, or notes that pertain to that specific topic stay in the FDK repo. Topics could include

• How to develop an Fn FDK.
• How to obtain an FDK.
• How to include the FDK in program dependencies when building a custom runtime image using a Dockerfile.

Examples: Here are some example doc sites that have a format we desire to imitate.

• Apache Open Whisk

Docs on using an FDK - Docs Repo

Documents describing the development of Fn functions using the FDK should go in the docs repository. Usage oriented content should go here.

Example: An article on setting up a development environment to create Fn functions that use an FDK.