Skip to content

Commit 54e8d73

Browse files
committed
docs: stop tracking placeholder documentation
The placeholder documentation introduces a couple of problems: - it complicates the contributor-experience (forces the CI to run N times before the contributor finds out that they need to call an .sh script and include certain files from docs/) - it forces CLI related pull requests for tools like kubeadm and kubectl to require top level approval from docs/OWNERS as such PRs still need to touch the .generated_docs file Stop tracking the placeholder documentation by applying the following actions: - remove the utility set-placeholder-gen-docs() - make verify-generated-docs.sh only generate in a temporary folder and not match .generated_docs - mark generate-docs.sh as an alias for update-generated-docs.sh - remove all current placeholder files in docs folders admin, man, user-guide, yaml - ignore the above folders and .generated_docs in a .gitignore file
1 parent 697c231 commit 54e8d73

File tree

444 files changed

+10
-1819
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

444 files changed

+10
-1819
lines changed

docs/.generated_docs

Lines changed: 0 additions & 436 deletions
This file was deleted.

docs/.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
.generated_docs
2+
admin/
3+
man/
4+
user-guide/
5+
yaml/

docs/admin/OWNERS

Lines changed: 0 additions & 10 deletions
This file was deleted.

docs/admin/cloud-controller-manager.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/admin/kube-apiserver.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/admin/kube-controller-manager.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/admin/kube-proxy.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/admin/kube-scheduler.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/admin/kubeadm.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/admin/kubeadm_alpha.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

0 commit comments

Comments
 (0)