docs: Add a guide for writing API services

Hopefully this is useful to companies who want to design their services
properly to support modern tooling.
This commit is contained in:
James Shubin
2024-08-16 23:38:27 -04:00
parent 7596f5b572
commit c5dc9c7650
2 changed files with 146 additions and 0 deletions

View File

@@ -96,6 +96,7 @@ Please read, enjoy and help improve our documentation!
| [function guide](docs/function-guide.md) | for mgmt developers |
| [resource guide](docs/resource-guide.md) | for mgmt developers |
| [style guide](docs/style-guide.md) | for mgmt developers |
| [service API guide](docs/service-guide.md) | for external developers |
| [godoc API reference](https://godoc.org/github.com/purpleidea/mgmt) | for mgmt developers |
| [prometheus guide](docs/prometheus.md) | for everyone |
| [puppet guide](docs/puppet-guide.md) | for puppet sysadmins |