Within the CockroachDB docs, we have the concept of a stable version and a dev version. We create a symbolic link for each of those versions in our docs site, so navigating to cockroachlabs.com/docs/stable/add-column.html points to the exact same page as cockroachlabs.com/docs/v22.1/add-column.html. Below is an abridged view of our directory structure:
We have a link defined in a88407.html with a target of ../stable/multiregion-overview.html#regional-by-row-tables. We're noticing that htmltest will throw an error:
docs/advisories/a88407.html
hash does not exist --- docs/advisories/a88407.html --> ../stable/multiregion-overview.html#regional-by-row-tables
If we change it to ../v22.1/multiregion-overview.html#regional-by-row-tables, it works fine. However, we want to point forever to stable, as the stable URL will rotate based on the latest GA release of our software.
To Reproduce
Steps to reproduce the behaviour:
Create a new folder somewhere.
In this folder, run the following:
mkdir s_dir
mkdir t_dir
ln -s t_ln t_dir
touch s_dir/s_file_ln.html
echo '<a href="../t_ln/t_file.html"><code>Click me</code></a>' >> s_dir/s_file_ln.html
# the above file uses the symbolic link directory
touch s_dir/s_file_dir.html
echo '<a href="../t_dir/t_file.html"><code>Click me</code></a>' > s_dir/s_file_dir.html
# the above file uses the real directory
touch t_dir/t_file.html
echo '<h1>Hello</h1>' > t_dir/t_file.html
touch .htmltest.yml
echo 'DirectoryPath: "."' >> .htmltest.yml
echo 'CheckDoctype: false' >> .htmltest.yml
htmltest
Observe how only s_file_ln.html, the file with the symbolic link, throws an error:
========================================================================
s_dir/s_file_ln.html
target does not exist --- s_dir/s_file_ln.html --> ../t_ln/t_file.html
========================================================================
✘✘✘ failed in 1.270165ms
1 errors in 3 documents
No error should be returned on files referenced via symbolic link.
Actual behaviour
The following error is thrown when referencing a file through a symbolically linked directory:
========================================================================
s_dir/s_file_ln.html
target does not exist --- s_dir/s_file_ln.html --> ../t_ln/t_file.html
========================================================================
✘✘✘ failed in 1.270165ms
1 errors in 3 documents
Describe the bug
Within the CockroachDB docs, we have the concept of a
stable
version and adev
version. We create a symbolic link for each of those versions in our docs site, so navigating to cockroachlabs.com/docs/stable/add-column.html points to the exact same page as cockroachlabs.com/docs/v22.1/add-column.html. Below is an abridged view of our directory structure:We have a link defined in
a88407.html
with a target of../stable/multiregion-overview.html#regional-by-row-tables
. We're noticing that htmltest will throw an error:If we change it to
../v22.1/multiregion-overview.html#regional-by-row-tables
, it works fine. However, we want to point forever tostable
, as thestable
URL will rotate based on the latest GA release of our software.To Reproduce
Steps to reproduce the behaviour:
s_file_ln.html
, the file with the symbolic link, throws an error:.htmltest.yml
Please copy in your config file
Our full
.htmltest.yml
can be found here: https://github.com/cockroachdb/docs/blob/master/.htmltest.ymlIf you wish to reproduce on our main site, do the following:
htmltest -s
.Source files
See To Reproduce.
Expected behaviour
No error should be returned on files referenced via symbolic link.
Actual behaviour
The following error is thrown when referencing a file through a symbolically linked directory:
Versions