From d9173cc9ba4c161ebcf32c865c20d1337f25b5af Mon Sep 17 00:00:00 2001 From: Matt Butcher <technosophos@gmail.com> Date: Wed, 15 Feb 2017 16:52:58 -0700 Subject: [PATCH] docs(index): Move doc index into a separate file. This removes the full TOC from the README and puts it in an index. This will help when we begin to autogenerate a website based on documentation. --- README.md | 34 +--------------------------------- docs/index.md | 35 +++++++++++++++++++++++++++++++++++ 2 files changed, 36 insertions(+), 33 deletions(-) create mode 100644 docs/index.md diff --git a/README.md b/README.md index ad1774210..ec559873c 100644 --- a/README.md +++ b/README.md @@ -48,39 +48,7 @@ including installing pre-releases. ## Docs -- [Quick Start](docs/quickstart.md) - Read me first! -- [Installing Helm](docs/install.md) - Install Helm and Tiller - - [Kubernetes Distribution Notes](docs/kubernetes_distros.md) - - [Frequently Asked Questions](docs/install_faq.md) -- [Using Helm](docs/using_helm.md) - Learn the Helm tools - - [Plugins](docs/plugins.md) -- [Developing Charts](docs/charts.md) - An introduction to chart development - - [Chart Lifecycle Hooks](docs/charts_hooks.md) - - [Chart Tips and Tricks](docs/charts_tips_and_tricks.md) - - [Chart Repository Guide](docs/chart_repository.md) - - [Syncing your Chart Repository](docs/chart_repository_sync_example.md) - - [Signing Charts](docs/provenance.md) - - [Writing Tests for Charts](docs/chart_tests.md) -- [Chart Template Developer's Guide](docs/chart_template_guide/index.md) - Master Helm templates - - [Getting Started with Templates](docs/chart_template_guide/getting_started.md) - - [Built-in Objects](docs/chart_template_guide/builtin_objects.md) - - [Values Files](docs/chart_template_guide/values_files.md) - - [Functions and Pipelines](docs/chart_template_guide/functions_and_pipelines.md) - - [Flow Control (if/else, with, range, whitespace management)](docs/chart_template_guide/control_structures.md) - - [Variables](docs/chart_template_guide/variables.md) - - [Named Templates (Partials)](docs/chart_template_guide/named_templates.md) - - [Accessing Files Inside Templates](docs/chart_template_guide/accessing_files.md) - - [Creating a NOTES.txt File](docs/chart_template_guide/notes_files.md) - - [Subcharts and Global Values](docs/chart_template_guide/subcharts_and_globals.md) - - [Debugging Templates](docs/chart_template_guide/debugging.md) - - [Wrapping Up](docs/chart_template_guide/wrapping_up.md) - - [Appendix A: YAML Techniques](docs/chart_template_guide/yaml_techniques.md) - - [Appendix B: Go Data Types](docs/chart_template_guide/data_types.md) -- [Related Projects](docs/related.md) - More Helm tools, articles, and plugins -- [Architecture](docs/architecture.md) - Overview of the Helm/Tiller design -- [Developers](docs/developers.md) - About the developers -- [History](docs/history.md) - A brief history of the project -- [Glossary](docs/glossary.md) - Decode the Helm vocabulary +Get started with the [Quick Start guide](docs/quickstart.md) or plunge into the [complete documentation](docs/index.md) ## Roadmap diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 000000000..b787463a6 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,35 @@ +# Helm Documentation + +- [Quick Start](quickstart.md) - Read me first! +- [Installing Helm](install.md) - Install Helm and Tiller + - [Kubernetes Distribution Notes](kubernetes_distros.md) + - [Frequently Asked Questions](install_faq.md) +- [Using Helm](using_helm.md) - Learn the Helm tools + - [Plugins](plugins.md) +- [Developing Charts](charts.md) - An introduction to chart development + - [Chart Lifecycle Hooks](charts_hooks.md) + - [Chart Tips and Tricks](charts_tips_and_tricks.md) + - [Chart Repository Guide](chart_repository.md) + - [Syncing your Chart Repository](chart_repository_sync_example.md) + - [Signing Charts](provenance.md) + - [Writing Tests for Charts](chart_tests.md) +- [Chart Template Developer's Guide](chart_template_guide/index.md) - Master Helm templates + - [Getting Started with Templates](chart_template_guide/getting_started.md) + - [Built-in Objects](chart_template_guide/builtin_objects.md) + - [Values Files](chart_template_guide/values_files.md) + - [Functions and Pipelines](chart_template_guide/functions_and_pipelines.md) + - [Flow Control (if/else, with, range, whitespace management)](chart_template_guide/control_structures.md) + - [Variables](chart_template_guide/variables.md) + - [Named Templates (Partials)](chart_template_guide/named_templates.md) + - [Accessing Files Inside Templates](chart_template_guide/accessing_files.md) + - [Creating a NOTES.txt File](chart_template_guide/notes_files.md) + - [Subcharts and Global Values](chart_template_guide/subcharts_and_globals.md) + - [Debugging Templates](chart_template_guide/debugging.md) + - [Wrapping Up](chart_template_guide/wrapping_up.md) + - [Appendix A: YAML Techniques](chart_template_guide/yaml_techniques.md) + - [Appendix B: Go Data Types](chart_template_guide/data_types.md) +- [Related Projects](related.md) - More Helm tools, articles, and plugins +- [Architecture](architecture.md) - Overview of the Helm/Tiller design +- [Developers](developers.md) - About the developers +- [History](history.md) - A brief history of the project +- [Glossary](glossary.md) - Decode the Helm vocabulary -- GitLab