All links to EDB Docs 1.0 from current versions rewritten#809
Merged
josh-heyer merged 8 commits intodevelopfrom Feb 1, 2021
Merged
All links to EDB Docs 1.0 from current versions rewritten#809josh-heyer merged 8 commits intodevelopfrom
josh-heyer merged 8 commits intodevelopfrom
Conversation
…termine from context
josh-heyer
changed the title
epbarger
approved these changes
Feb 1, 2021
| } | ||
| } | ||
|
|
||
| const titleMap = { |
Contributor
There was a problem hiding this comment.
I should have thought to send you my redirects metadata file, it has this information in a fairly similar format 😬
|
|
||
|
|
||
| const urlMap = { | ||
| /* these are unique to this file */ |
Contributor
There was a problem hiding this comment.
This works, but I wouldn't be upset if you wanted to break this out into a .json file specific for this script ;)
pipetogrep
pushed a commit
that referenced
this pull request
Mar 18, 2021
* deep links to EDB Docs 1.0 rewritten * rewrite root links to EDB Docs 1.0 to deep links where possible to determine from context * manually rewritten links to EDB Docs 1.0 * the scripts used to assist in rewriting EDB Docs 1.0 links * re-enable link-checker * couple of links to PostgreSQL docs missed by script * manual rewrite of references to /resources/product-documentation
edb-slonik
pushed a commit
that referenced
this pull request
Mar 11, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
As I expected, this was a fair bit of manual work. However, it wasn't as bad as I had feared: due to the work that @epbarger put in on the redirects, I was able to re-write most deep links without significant effort. This took care of 47 links.
Shallow links - those that simply pointed to /edb-docs - were a bit more work. In the majority of cases, the intended context for the link was represented in the text that preceded it; either in the same sentence, or in a preceding paragraph. I extracted this text, and with the help of a few infernal regexps was able to compile a short list of titles for various documentation sections; I then looked these up and built a table of mappings between the titles and paths within our documentation. This took care of another 103 links.
This left about 13 links that I had to figure out by hand and re-write.
I also re-wrote the text of links where it contained
https://www.enterprisedb.com/edb-docsto point tohttps://www.enterprisedb.com/docsThe script which assisted me in this task (along with Evan's redirects) can be found in scripts/normalization/lib/docs1-link-rewriter.js - it runs as a part of my normalization script, along with the checker/rewriter for fragment-links, table conversion, etc.
I ran this on the current versions found in
/product_docs; it can be run on older product versions, but will need similar hand-holding or manual work to complete.This PR fixes #801