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

Spring vault docs shows hyperlink instead of text #12

Closed
avinash28196 opened this issue May 27, 2021 · 1 comment
Closed

Spring vault docs shows hyperlink instead of text #12

avinash28196 opened this issue May 27, 2021 · 1 comment

Comments

@avinash28196
Copy link

I was going through the spring vault docs Link to the docs and saw an issue with adoc file. Instead of including the content mentioned in the URI, it shows the URI itself.

Upon looking Adoc guideline It says

The include directive recognizes when the target is a URI and can include the content referenced by that URI.
This example demonstrates how to include an AsciiDoc file from a GitHub repository directly into your document.
include::https://raw.githubusercontent.com/asciidoctor/asciidoctor/master/README.adoc[]
For security reasons, this capability is not enabled by default. To allow content to be read from a URI, 
you must enable the URI read permission by:

Screenshot for reference:
image

@robertmcnees
Copy link
Contributor

Hi @avinash28196. Thanks for the issue. As you've found in the provided link, this is a common scenario with asciidoc and not rendering the include directives is a security choice.

I'm not sure if the screenshot provided is from GitHub or your IDE. If it is from your IDE, you should be able to modify the security settings so that it renders the include directives locally. In GitHub, it is not so straightforward. I created this issue in our template repository to track this at a higher level. All of our guides, and indeed any asciidoc on GitHub, has the same issue.

The deploy script we use should render these includes, so you should not see this in the rendered guide.

I'll close this issue in favor of tracking it on the template repository instead. More context, history, and potential solutions can be found there.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants