Unreferenced Doc File Review - fnproject/docs GitHub Wiki

This is a list of files that were not moved to the docs repo because they were not referenced in the docs. Files are listed by directory with a count of the files not moved for each directory. Detailed descriptions and suggested actions are provided below.

docs (2)

  • Swagger files stay where they are.
  • definitions.md - Compares using CLI to using REST API (Delete)
  • serverless.md - Intro to Serverless Computing (Delete)

contributors (2)

Files discuss extending Fn using annotations and extensions. Seems like this should go under develop directory.

developing (6)

These files were not copied to the new docs repository.

  • cloudevents.md - Cloud events notes. (Copied. Linked. Done)
  • ce-example.json - Goes with Cloud events (Copied. Linked. Done)
  • function-timeouts.md - Overview of function timeouts. (Copied. Linked. Done)
  • hybrid.md - Looks like a proposal? Old file. (Delete. Per Reed.)
  • model.md - Covers Fn objects. Pretty light (Delete)
  • usage.md - Detailed example of using CLI. Out of date. Could be updated or not. (?)

lambda (6)

Coverage of Fn lambda features. Looks old. (Delete?, copy?)

operating (5 files, 3 dirs)

Files not linked into documentation.

  • local-testing.md - Tips on local testing. (Copied. Linked. Done)
  • routes.md - Has a good section on memory. Maybe keep that and update for triggers? (Delete. All Route related.)
  • runner_pools.md - How to run 3 fn servers as a pool with an LB. (Copied. Linked. Done)
  • scaling.md - Empty file. (Delete)
  • selinux.md - SE Linux tips (Copied. Linked. Done)

databases (4)

Coverages databases that can be used to run Fn. (Copied. Linked. Done)

logs (1)

Covers using sqlite3 and minio as log stores. Need guidance. Based on what I know this should be deleted. (Delete)

readme

mqs (1)

Message Q support for running Fn. (Delete. Dup of message-queues.md)

Readme