Uploaded image for project: 'C# Driver'
  1. C# Driver
  2. CSHARP-4158

Remove edit links from gh-pages

    XMLWordPrintable

Details

    • Task
    • Status: Backlog
    • Unknown
    • Resolution: Unresolved
    • None
    • None
    • Documentation
    • None

    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.

      Attachments

        Activity

          People

            Unassigned Unassigned
            james.kovacs@mongodb.com James Kovacs
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated: