docs(fix): Make best practices docs look better

[kavirajk]

What this PR does / why we need it:
Request from @osg-grafana from Grafana Enterprise Loki. Goal is to make best practices doc layout look bit more professional.

Say from this
https://grafana.com/docs/loki/v2.1.0/best-practices/current-best-practices/

to this
https://grafana.com/docs/loki/v2.1.0/best-practices/

Which issue(s) this PR fixes:
Fixes #
NA

Special notes for your reviewer:
This is just for "latest" version of Loki docs. Same thing done for versioned docs on website repo https://github.com/grafana/website/pull/3414/

Checklist

• Documentation added

[osg-grafana]

@oddlittlebird and @achatterjee-grafana, this PR moves the best practices up a level so that extraneous nesting goes away. Content changes can be handled in subsequent PRs. This PR introduces potential broken links that refer to these best practices.

[achatterjee-grafana]

@osg-grafana, will the broken relrefs get fixed as a priority? Moving a level up makes sense to me.

[osg-grafana]

@osg-grafana, will the broken relrefs get fixed as a priority? Moving a level up makes sense to me.

Yes

[oddlittlebird]

Theoretically, you shouldn't be able to pass e2e testing with broken relrefs, so fixing them is kind of required.

[cyriltovena]

LGTM

[osg-grafana]

Theoretically, you shouldn't be able to pass e2e testing with broken relrefs, so fixing them is kind of required.

Ok, so it looks like we do not have to worry about checking links manually. If that is not the case, please let me know. Otherwise, ticking this off my TODO list.

[achatterjee-grafana]

If you do a local doc build, broken relrefs should get flagged. If they did not, then the system is broken. That is why Diana mentioned that theoretically, you should not able to merge with broken relrefs.

[osg-grafana]

Thanks for the details. I understood that CI would catch those.

[oddlittlebird]

We've had some sneak through, but haven't been able to narrow down a set of circumstances that allow that to happen.

…

On Thu, Feb 11, 2021 at 7:31 AM Ursula Kallio ***@***.***> wrote: Thanks for the details. I understood that CI would catch those. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#3316 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AMNF6KIIM2YOR4QCJWLTK6DS6PZ5HANCNFSM4XMUQVNA> .

-- Diana Payton (She/Her) Sr. Technical Writer at Grafana Labs