Skip to content

report_issue_url cannot be configured in config/tech-docs.yaml #283

@lfdebrux

Description

@lfdebrux

Currently the tech docs documentation tells users that they can configure the url for the 'report problem' link by adding some configuration to config/tech-docs.yaml [1]. Unfortunately, a bug in the implementation of this feature means that the configuration actually has to be added to config.rb:

url = config[:source_urls]&.[](:report_issue_url)

Line 22 should actually read source_urls from the tech_docs hash.

What should change

We should change it so that the configuration is read from config/tech-docs.yaml, while retaining a fallback ability to configure from config.rb as before, to avoid a breaking change.

User need

As a user I need to be able to use example code from the documentation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions