-
Notifications
You must be signed in to change notification settings - Fork 0
Introduction
The system allows you to manage the documentation of the following high-level entities:
- Organizations
- Projects
-
Services
- Endpoints (e.g. OpenAPI, GRPC, GraphQL)
- Environments
-
Repositories
- Code Project (e.g. .csproj)
-
Services
- Package Feeds (e.g. NuGet)
- Projects
The organization is the entry point to other entities and usually represents a company with its projects and package feeds.
For more information, see Organizations.
TBD.
For more information, see Projects.
A service represents a logical microservice with a well defined public API surface, called Endpoints. A service can have one deployment per environment. Each deployment can have its own health state and version. A service can reference packages of a package feed - usually these are SDK client libraries to use the service.
For more information, see Services.
An endpoint is an API which can be consumed by other services or external consumers. There are various endpoint types like OpenAPI, GRPC or GraphQL.
For more information, see Endpoints.
TBD.
For more information, see Environments.
TBD.
TBD.