3 ms·
Google is not going to take me to that page first when I search for how to do something in Caddy. It's going to take me to the directive, most likely. To say i
by withinboredom 3y ago
Google is not going to take me to that page first when I search for how to do something in Caddy. It's going to take me to the directive, most likely.
To say it again:
> It's all very confusing for someone looking in the docs for a solution and instead has to learn how everything works, whether they want to or not.
- mholt 3y agoHow can we fix this without repeating the Concepts page on every page of our docs? Maybe we should just un-index all docs pages except the intro pages.
- withinboredom 3y agoI think there are several ways to handle that. Assuming you are using templates for the docs: 1. A simple link like this: https://docs.k3s.io/installation/configuration#:~:text=For%20details%20on%20configuring%20the%20K3s%20server%2C%20see%20the%20k3s%20server%20documentation https://docs.k3s.io/installation/configuration#:~:text=For%2.... 2. An aside at the top that informs the person where to get more information with a link. 3. An example showing the structure of the file. 4. A link to examples/tests in the repo showing how it can be used. I would think that a simple aside in your template would work wonders. Maybe saying something like: > See our page on [directives](link) to learn how to best use this in your configuration.