search

laminas / laminas-di

Automated dependency injection for PSR-11 containers
https://docs.laminas.dev/laminas-di/
BSD 3-Clause "New" or "Revised" License
36 stars 20 forks source link

Simplify redirects of legacy docs #33

Closed driehle closed 2 years ago

driehle commented 2 years ago
Q A
Documentation yes
Bugfix no
BC Break no
New Feature no
RFC no
QA no

Description

The docs folder contains several manual redirects, i.d. HTML documents with a hard-coded redirect for legacy URLs. With the adoption of the MkDocs redirect plugin there is a simpler solution available.

This PR moves the redirects for legacy URLs in mkdocs.yml and removes the manually created HTML documents from Git.

tux-rampage commented 2 years ago

Nice improvement, thanks.

@froschdesign could you please double check if this would work out for the docs builder that we've got in place?

driehle commented 2 years ago

Should I take care of the markdownlint issues?

froschdesign commented 2 years ago

Should I take care of the markdownlint issues?

That would be great! A separate commit is good.

Please use <!-- markdownlint-disable-next-line header-increment --> here:

https://github.com/laminas/laminas-di/blob/83330af17fc2511231e805a3586d51883a452094/docs/book/v3/codegen.md#L8-L17

A solution for the future would be to find a headline before this section or to find a better markup than a blockquote.

The blockquote element represents a section that is quoted from another source.

https://html.spec.whatwg.org/multipage/grouping-content.html#the-blockquote-element