diff --git a/doc/docs/packages/generator.md b/doc/docs/packages/generator.md index ad75de0..95faa04 100644 --- a/doc/docs/packages/generator.md +++ b/doc/docs/packages/generator.md @@ -731,7 +731,7 @@ func (s *Secret) Yaml() ([]byte, error) Yaml returns the yaml representation of the secret. -## type [Service]() +## type [Service]() Service is a kubernetes Service. @@ -743,7 +743,7 @@ type Service struct { ``` -### func [NewService]() +### func [NewService]() ```go func NewService(service types.ServiceConfig, appName string) *Service @@ -752,7 +752,7 @@ func NewService(service types.ServiceConfig, appName string) *Service NewService creates a new Service from a compose service. -### func \(\*Service\) [AddPort]() +### func \(\*Service\) [AddPort]() ```go func (s *Service) AddPort(port types.ServicePortConfig, serviceName ...string) @@ -761,7 +761,7 @@ func (s *Service) AddPort(port types.ServicePortConfig, serviceName ...string) AddPort adds a port to the service. -### func \(\*Service\) [Filename]() +### func \(\*Service\) [Filename]() ```go func (s *Service) Filename() string @@ -770,7 +770,7 @@ func (s *Service) Filename() string Filename returns the filename of the service. -### func \(\*Service\) [Yaml]() +### func \(\*Service\) [Yaml]() ```go func (s *Service) Yaml() ([]byte, error) diff --git a/doc/docs/usage.md b/doc/docs/usage.md index 3c010f4..cae2ac7 100644 --- a/doc/docs/usage.md +++ b/doc/docs/usage.md @@ -145,7 +145,7 @@ For more complete label usage, see [the labels page](labels.md). ### Work with Depends On? -Kubernetes does not provide service or pod starting detection from others pods. But katenary will create init containers +Kubernetes does not provide service or pod starting detection from others pods. But Katenary will create `initContainer` to make you able to wait for a service to respond. But you'll probably need to adapt a bit the compose file. See this compose file: