gardener / documentation

Documentation and website
Apache License 2.0
34 stars 67 forks source link

Unnecessary usage of `<doc>/_index.md` files instead of `doc.md` #511

Closed Kostov6 closed 1 month ago

Kostov6 commented 1 month ago

What would you like to be added: There are a lot of documents that are like this https://github.com/gardener/documentation/tree/master/website/documentation/getting-started/common-pitfalls https://github.com/gardener/documentation/tree/master/website/documentation/getting-started/lifecycle https://github.com/gardener/documentation/tree/master/website/documentation/getting-started/project https://github.com/gardener/documentation/tree/master/website/documentation/getting-started/shoots

Example of proper usage: https://github.com/gardener/documentation/tree/master/website/documentation/getting-started/features

And there is no difference in how they are rendered: https://gardener.cloud/docs/getting-started/shoots/ vs https://gardener.cloud/docs/getting-started/features/dns-management/

Why is this needed: Simpler file structure