Skip to content

Commit

Permalink
Move api-reference doc files to /docs directory
Browse files Browse the repository at this point in the history
  • Loading branch information
Zhelyazkov committed Nov 5, 2021
1 parent 97e2e31 commit c2d3380
Show file tree
Hide file tree
Showing 16 changed files with 25 additions and 17 deletions.
24 changes: 16 additions & 8 deletions .docforge/manifest.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,67 +3,75 @@
structure:
- name: _index.md
source: https://github.com/gardener/gardener/blob/{{$defaultBranch}}/README.md
- name: api-reference
properties:
frontmatter:
title: API Reference
weight: 1
nodes:
- nodesSelector:
path: https://github.com/gardener/gardener/tree/{{$defaultBranch}}/docs/api-reference
- name: concepts
properties:
frontmatter:
title: Concepts
weight: 1
weight: 2
nodes:
- nodesSelector:
path: https://github.com/gardener/gardener/tree/{{$defaultBranch}}/docs/concepts
- name: deployment
properties:
frontmatter:
title: Deployment
weight: 2
weight: 3
nodes:
- nodesSelector:
path: https://github.com/gardener/gardener/tree/{{$defaultBranch}}/docs/deployment
- name: development
properties:
frontmatter:
title: Development
weight: 3
weight: 4
nodes:
- nodesSelector:
path: https://github.com/gardener/gardener/tree/{{$defaultBranch}}/docs/development
- name: extensions
properties:
frontmatter:
title: Extensions
weight: 4
weight: 5
nodes:
- nodesSelector:
path: https://github.com/gardener/gardener/tree/{{$defaultBranch}}/docs/extensions
- name: monitoring
properties:
frontmatter:
title: Monitoring
weight: 5
weight: 6
nodes:
- nodesSelector:
path: https://github.com/gardener/gardener/tree/{{$defaultBranch}}/docs/monitoring
- name: proposals
properties:
frontmatter:
title: Proposals
weight: 6
weight: 7
nodes:
- nodesSelector:
path: https://github.com/gardener/gardener/tree/{{$defaultBranch}}/docs/proposals
- name: testing
properties:
frontmatter:
title: Testing
weight: 7
weight: 8
nodes:
- nodesSelector:
path: https://github.com/gardener/gardener/tree/{{$defaultBranch}}/docs/testing
- name: usage
properties:
frontmatter:
title: Usage
weight: 8
weight: 9
nodes:
- nodesSelector:
path: https://github.com/gardener/gardener/tree/{{$defaultBranch}}/docs/usage
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 2 additions & 2 deletions hack/clean.sh
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,6 @@ for source_tree in $@; do
grep -lr '// Code generated by lister-gen. DO NOT EDIT' "$(dirname "$source_tree")" | xargs rm -f
done

if [ -d "$PWD/hack/api-reference" ]; then
find ./hack/api-reference/ -type f -name "*.md" -exec rm '{}' \;
if [ -d "$PWD/docs/api-reference" ]; then
find ./docs/api-reference/ -type f -name "*.md" -exec rm '{}' \;
fi
2 changes: 1 addition & 1 deletion pkg/apis/authentication/v1alpha1/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ limitations under the License.
// +k8s:defaulter-gen=TypeMeta
// +k8s:protobuf-gen=package

//go:generate gen-crd-api-reference-docs -api-dir . -config ../../../../hack/api-reference/authentication-config.json -template-dir ../../../../hack/api-reference/template -out-file ../../../../hack/api-reference/authentication.md
//go:generate gen-crd-api-reference-docs -api-dir . -config ../../../../hack/api-reference/authentication-config.json -template-dir ../../../../hack/api-reference/template -out-file ../../../../docs/api-reference/authentication.md

// Package v1alpha1 is a version of the API.
// +groupName=authentication.gardener.cloud
Expand Down
2 changes: 1 addition & 1 deletion pkg/apis/core/v1beta1/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
// +k8s:defaulter-gen=TypeMeta
// +k8s:protobuf-gen=package

//go:generate gen-crd-api-reference-docs -api-dir . -config ../../../../hack/api-reference/core-config.json -template-dir ../../../../hack/api-reference/template -out-file ../../../../hack/api-reference/core.md
//go:generate gen-crd-api-reference-docs -api-dir . -config ../../../../hack/api-reference/core-config.json -template-dir ../../../../hack/api-reference/template -out-file ../../../../docs/api-reference/core.md

// Package v1beta1 is a version of the API.
// +groupName=core.gardener.cloud
Expand Down
2 changes: 1 addition & 1 deletion pkg/apis/extensions/v1alpha1/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

// +k8s:deepcopy-gen=package

//go:generate gen-crd-api-reference-docs -api-dir . -config ../../../../hack/api-reference/extensions-config.json -template-dir ../../../../hack/api-reference/template -out-file ../../../../hack/api-reference/extensions.md
//go:generate gen-crd-api-reference-docs -api-dir . -config ../../../../hack/api-reference/extensions-config.json -template-dir ../../../../hack/api-reference/template -out-file ../../../../docs/api-reference/extensions.md

// Package v1alpha1 is the v1alpha1 version of the API.
// +groupName=extensions.gardener.cloud
Expand Down
2 changes: 1 addition & 1 deletion pkg/apis/operations/v1alpha1/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
// +k8s:defaulter-gen=TypeMeta
// +k8s:protobuf-gen=package

//go:generate gen-crd-api-reference-docs -api-dir . -config ../../../../hack/api-reference/operations-config.json -template-dir ../../../../hack/api-reference/template -out-file ../../../../hack/api-reference/operations.md
//go:generate gen-crd-api-reference-docs -api-dir . -config ../../../../hack/api-reference/operations-config.json -template-dir ../../../../hack/api-reference/template -out-file ../../../../docs/api-reference/operations.md

// Package v1alpha1 is a version of the API.
// +groupName=operations.gardener.cloud
Expand Down
2 changes: 1 addition & 1 deletion pkg/apis/resources/v1alpha1/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
// +k8s:openapi-gen=true
// +k8s:defaulter-gen=TypeMeta

//go:generate gen-crd-api-reference-docs -api-dir . -config ../../../../hack/api-reference/resources-config.json -template-dir ../../../../hack/api-reference/template -out-file ../../../../hack/api-reference/resources.md
//go:generate gen-crd-api-reference-docs -api-dir . -config ../../../../hack/api-reference/resources-config.json -template-dir ../../../../hack/api-reference/template -out-file ../../../../docs/api-reference/resources.md

// Package v1alpha1 contains the configuration of the Gardener Resource Manager.
// +groupName=resources.gardener.cloud
Expand Down
2 changes: 1 addition & 1 deletion pkg/apis/seedmanagement/v1alpha1/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
// +k8s:defaulter-gen=TypeMeta
// +k8s:protobuf-gen=package

//go:generate gen-crd-api-reference-docs -api-dir . -config ../../../../hack/api-reference/seedmanagement-config.json -template-dir ../../../../hack/api-reference/template -out-file ../../../../hack/api-reference/seedmanagement.md
//go:generate gen-crd-api-reference-docs -api-dir . -config ../../../../hack/api-reference/seedmanagement-config.json -template-dir ../../../../hack/api-reference/template -out-file ../../../../docs/api-reference/seedmanagement.md

// Package v1alpha1 is a version of the API.
// +groupName=seedmanagement.gardener.cloud
Expand Down
2 changes: 1 addition & 1 deletion pkg/apis/settings/v1alpha1/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
// +k8s:defaulter-gen=TypeMeta
// +k8s:protobuf-gen=package

//go:generate gen-crd-api-reference-docs -api-dir . -config ../../../../hack/api-reference/settings-config.json -template-dir ../../../../hack/api-reference/template -out-file ../../../../hack/api-reference/settings.md
//go:generate gen-crd-api-reference-docs -api-dir . -config ../../../../hack/api-reference/settings-config.json -template-dir ../../../../hack/api-reference/template -out-file ../../../../docs/api-reference/settings.md

// Package v1alpha1 is a version of the API.
// +groupName=settings.gardener.cloud
Expand Down

0 comments on commit c2d3380

Please sign in to comment.