Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
lfdebrux opened this issue Nov 22, 2021 · 0 comments
Open

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

lfdebrux opened this issue Nov 22, 2021 · 0 comments
Labels
bug Something isn't working

Comments

@lfdebrux
Copy link
Member

lfdebrux commented Nov 22, 2021

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.

@lfdebrux lfdebrux added the bug Something isn't working label Nov 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant