[CSHARP-4158] Remove edit links from gh-pages Created: 28/Apr/22  Updated: 02/May/22

Status: Backlog
Project: C# Driver
Component/s: Documentation
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Unknown
Reporter: James Kovacs Assignee: Unassigned
Resolution: Unresolved Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified


 Description   

The driver documentation on gh-pages contains edit links, which are currently broken.

themes/mongodb/layouts/partials/header/contentHeader.html contains a root URL of docs/reference/content, which returns a 404 because the correct root URL is Docs/reference/content (note the upper case "D").

As well the Hugo script for generating the documentation links inserts a backslash (%5c) for nested pages, which also produces a 404. For example:

https://github.com/mongodb/mongo-csharp-driver/blob/master/docs/reference/content/getting_started%5cindex.md

Given that we have received few if any pull requests with documentation fixes via this mechanism over the years, I recommend removing the edit links from the live gh-pages as well as from the above-mentioned template.


Generated at Wed Feb 07 21:47:24 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.