Allow doc redirects and rename VersionVault to ClearCase.
Review Request #14438 — Created May 16, 2025 and submitted
This change allows documentation page paths to be redirected to other
pages. We follow what we do for our Review Board codebase docs, where we:
- Add aredirects.json
file that contains the redirect info
- Point to that file incollect_file_patterns
in ourconf.py
- Rely on thebeanbag_docutils.sphinx.ext.collect_files
extension to
collect the redirect info.In 2024, HCL rebranded VersionVault to HCL DevOps Code ClearCase.
Power Pack 6 renames theVersionVault / ClearCase
SCM tool to
ClearCase
. This change updates the RBTools documentation
accordingly. We keep all of the old reference labels alongside the new
ones, to make sure any existing documentation that uses the old labels
still works.We don't need to add the new SCM tool name (
ClearCase
)
to theserver_tool_names
list on the Clear Case client, because the
server_tool_names
list will match against theSCMTool.lookup_name
instead ofSCMTool.name
on Review Board 6.0.3+, which points to the
oldVersionVault / ClearCase
name in Power Pack 6. This means that
older versions of RBTools will be compatible with Power Pack 6, as long
as they are using Review Board 6.0.3 (which is already a requirement
for using the SCM tool and hosting service features in Power Pack 6).
RBTools 5.0.1+ matches SCM tools using server tool IDs instead of
relying on tool names anyways, so we don't have to worry about renaming
and compatibility moving forward either.
- Built the docs, served them on rbwebsite and viewed them. Made
sure redirects work.
Summary | ID |
---|---|
eaef82a34767ee30ccc820949e234805c90c7acc |
Description | From | Last Updated | ||
---|---|---|---|---|
I have a note about this in the other change on how we might approach renaming the old one to … |
|
|||
There are no open issues |

- Change Summary:
-
Uses the legacy name for RB's ClearCase tool.
- Description:
-
This change allows documentation page paths to be redirected to other
pages. We follow what we do for our Review Board codebase docs, where we: - Add a redirects.json
file that contains the redirect info- Point to that file in collect_file_patterns
in ourconf.py
- Rely on the beanbag_docutils.sphinx.ext.collect_files
extension tocollect the redirect info. In 2024, HCL rebranded VersionVault to HCL DevOps Code ClearCase.
Power Pack 6 renames the VersionVault / ClearCase
SCM tool to~ ClearCase (Power Pack)
. This change updates the RBTools documentation~ ClearCase
. This change updates the RBTools documentationaccordingly. We keep all of the old reference labels alongside the new ones, to make sure any existing documentation that uses the old labels still works. ~ We don't need to add the new SCM tool name (
ClearCase (Power Pack)
)~ We don't need to add the new SCM tool name (
ClearCase
)to the server_tool_names
list on the Clear Case client, because theserver_tool_names
list will match against theSCMTool.lookup_name
instead of SCMTool.name
on Review Board 6.0.3+, which points to theold VersionVault / ClearCase
name in Power Pack 6. This means thatolder versions of RBTools will be compatible with Power Pack 6, as long as they are using Review Board 6.0.3 (which is already a requirement for using the SCM tool and hosting service features in Power Pack 6). RBTools 5.0.1+ matches SCM tools using server tool IDs instead of relying on tool names anyways, so we don't have to worry about renaming and compatibility moving forward either. - Commits:
-
Summary ID 8b20ce27d1e9b2a0f308ff7d18418135c9ca15b3 eaef82a34767ee30ccc820949e234805c90c7acc