Merge pull request #516 from burnettk/refer-to-correct-docs-directory
docs/spec: correct doc/spec to docs/spec everywhere
This commit is contained in:
commit
1a829c8f51
@ -90,11 +90,11 @@ PR titles should be lowercased, except for proper noun references (such a
|
|||||||
method name or type).
|
method name or type).
|
||||||
|
|
||||||
PR titles should be prefixed with affected directories, comma separated. For
|
PR titles should be prefixed with affected directories, comma separated. For
|
||||||
example, if a specification is modified, the prefix would be "doc/spec". If
|
example, if a specification is modified, the prefix would be "docs/spec". If
|
||||||
the modifications are only in the root, do not include it. If multiple
|
the modifications are only in the root, do not include it. If multiple
|
||||||
directories are modified, include each, separated by a comma and space.
|
directories are modified, include each, separated by a comma and space.
|
||||||
|
|
||||||
Here are some examples:
|
Here are some examples:
|
||||||
|
|
||||||
- doc/spec: move API specification into correct position
|
- docs/spec: move API specification into correct position
|
||||||
- context, registry, auth, auth/token, cmd/registry: context aware logging
|
- context, registry, auth, auth/token, cmd/registry: context aware logging
|
||||||
|
@ -4,7 +4,7 @@
|
|||||||
// For example, to generate a new API specification, one would execute the
|
// For example, to generate a new API specification, one would execute the
|
||||||
// following command from the repo root:
|
// following command from the repo root:
|
||||||
//
|
//
|
||||||
// $ registry-api-descriptor-template doc/spec/api.md.tmpl > doc/spec/api.md
|
// $ registry-api-descriptor-template docs/spec/api.md.tmpl > docs/spec/api.md
|
||||||
//
|
//
|
||||||
// The templates are passed in the api/v2.APIDescriptor object. Please see the
|
// The templates are passed in the api/v2.APIDescriptor object. Please see the
|
||||||
// package documentation for fields available on that object. The template
|
// package documentation for fields available on that object. The template
|
||||||
|
Loading…
Reference in New Issue
Block a user