Fix broken links: Documentation about CrateDB Edge has been removed

[amotl]

About

What the title says.

References

• Remove Edge from documentation cloud-docs#97

[bmunkholm]

Thanks again!

[bmunkholm]

@amotl For my education, I wonder if we don't have any link checking across the various documentation projects? And subsequent what the best practices are to ensure all links between doc projects are good?

[amotl]

For my education, I wonder if we don't have any link checking across the various documentation projects?

We do. It is exactly the link checker which was tripping on this occasion, as observed on your other patch GH-199. Of course, intersphinx references are special anyway and also trip regular documentation builds, that's why the RTD job also failed.

Using intersphinx references is the best way to quickly detect and resolve dangling reference pointer situations like this one, because it enforces strong links between otherwise independent projects, detecting any kinds of symbol errors on the same level like software linters are doing it, i.e.: It just will not build at all. In this spirit, relevant intersphinx mechanisms already built into Sphinx itself implicitly provide the best thing since sliced bread in this regard.

On the other hand, for validating the integrity of plain old HTTP link references, Sphinx offers a dedicated "linkcheck" builder, which is employed on our CI workflows across the board and can be invoked in your sandbox using make check within the docs/ folder.

And subsequent what the best practices are to ensure all links between doc projects are good?

The common practice is to fix forward, by submitting patches like this one. There is also a job on Jenkins called rebuild_all_docs, which will re-build all the docs across all projects. Amongst other use cases, it can be used as a super linkchecker if you like the idea.