lyft / clutch

Extensible platform for infrastructure management

Home Page:https://clutch.sh

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

docs: topology api's, cache, and autocomplete

mikecutalo opened this issue · comments

Description

In #921 we completed autocomplete for all AWS and Kubernetes workflows. Along the way many new API's and core systems were developed that need to be documented. These systems can be leveraged in a verity of ways and autocomplete is just one use case for them.

The docs should include:

  • Basic topology service overview
  • topology API's
  • the topology cache
  • how to leverage the CacheableTopology interface
  • how to enable autocomplete