Uploaded image for project: 'Jenkins Website'
  1. Jenkins Website
  2. WEBSITE-257

Edit link in docs broken

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Done (View Workflow)
    • Priority: Minor
    • Resolution: Fixed
    • Component/s: core
    • Labels:
      None
    • Similar Issues:

      Description

      One navigating to pipeline plugin docs, the "Improve this page" link is broken.

      Example: https://jenkins.io/doc/pipeline/steps/pipeline-input-step/

      This is probably due to this page being generated from resources outside of the repository.

        Attachments

          Issue Links

            Activity

            Hide
            mmccaskill Michael McCaskill added a comment -

            Actually this isn't related to the plugin-site but the normal website. I'm not sure if this should be Tyler or Daniel so I'll just change it to automatic and see what happens.

            Show
            mmccaskill Michael McCaskill added a comment - Actually this isn't related to the plugin-site but the normal website. I'm not sure if this should be Tyler or Daniel so I'll just change it to automatic and see what happens.
            Hide
            danielbeck Daniel Beck added a comment -

            Right, we probably should have an option that can be set and removes the link for the few special pages that cannot be edited for whatever reason.

            Same issue once we actually generate Pipeline step doc properly there.

            Show
            danielbeck Daniel Beck added a comment - Right, we probably should have an option that can be set and removes the link for the few special pages that cannot be edited for whatever reason. Same issue once we actually generate Pipeline step doc properly there.
            Hide
            rtyler R. Tyler Croy added a comment -

            Daniel Beck, if we were to provide an "edit" link for the generated step documentation, where would it point?

            If we point to the pipeline-steps-doc-generator, I'm not sure that would be useful to a contributor like Florian Gilcher.

            Would it be better to just link to the GitHub repository which contains the step, or try to navigate all the way to the source file which contains the javadocs?

            Show
            rtyler R. Tyler Croy added a comment - Daniel Beck , if we were to provide an "edit" link for the generated step documentation, where would it point? If we point to the pipeline-steps-doc-generator , I'm not sure that would be useful to a contributor like Florian Gilcher . Would it be better to just link to the GitHub repository which contains the step, or try to navigate all the way to the source file which contains the javadocs?
            Hide
            danielbeck Daniel Beck added a comment -

            To clarify, you actually want an edit link everywhere? Because what I tried to say is that we should just have a method to remove that link on certain pages, and remove it from those without a real 'source' file.

            Show
            danielbeck Daniel Beck added a comment - To clarify, you actually want an edit link everywhere? Because what I tried to say is that we should just have a method to remove that link on certain pages, and remove it from those without a real 'source' file.
            Hide
            rtyler R. Tyler Croy added a comment -

            I would prefer to maintain the link in some form, everywhere, since all the content is editable somewhere, otherwise potential contributions go to /dev/null.

            I'll pester Kristin Whetstone about this and see what we can come up with

            Show
            rtyler R. Tyler Croy added a comment - I would prefer to maintain the link in some form, everywhere, since all the content is editable somewhere , otherwise potential contributions go to /dev/null . I'll pester Kristin Whetstone about this and see what we can come up with
            Hide
            danielbeck Daniel Beck added a comment -

            Well, whether it's a boolean disable or a String sourceUrlOverride shouldn't make a huge difference from an implementation POV – both require customization of the link, and both would resolve the brokenness.

            Linking somewhere useful would be preferable over just removing the link.

            Show
            danielbeck Daniel Beck added a comment - Well, whether it's a boolean disable or a String sourceUrlOverride shouldn't make a huge difference from an implementation POV – both require customization of the link, and both would resolve the brokenness. Linking somewhere useful would be preferable over just removing the link.
            Hide
            zbynek Zbynek Konecny added a comment -
            Show
            zbynek Zbynek Konecny added a comment - Marking this as done ( https://github.com/jenkins-infra/jenkins.io/pull/643 )

              People

              Assignee:
              Unassigned Unassigned
              Reporter:
              skade Florian Gilcher
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved: