Fn FDK Documentation Guidelines

This page contains general documentation guidelines for the Fn project. Any decisions about handling docs will be written here.

Audience

What is the audience for FDK content? There are 3 groups of people that might land on these pages:

1. General Fn users, developers.
2. Fn developers that want to use the FDK for their functions.
3. Developers who want to work on the FDK or create a new one.

Where to put Function Development Kit Documentation

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-language Repo

Docs stored here should cover how to develop an FDK for Fn. Content should focus on group 3 as described in audience. Any articles, tutorials, examples, or notes that pertain to FDK development should stay in the FDK repo. Topics could include:

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

Docs on Function Development using an FDK - docs Repo

Documents describing the development of Fn functions using an FDK should go in the docs repository. Users that fall into groups 1 and 2 as described in audience. Usage oriented content should go here.

Naming Guidelines in Docs

See Fn Project Documentation Naming Rules for any naming rules related to the Fn Project.

Examples

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

• Apache Open Whisk