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

GitHub do not render asciidoc include directive #64

Open
kral2 opened this issue Sep 7, 2021 · 0 comments
Open

GitHub do not render asciidoc include directive #64

kral2 opened this issue Sep 7, 2021 · 0 comments
Labels
bug Something isn't working documentation Improvements or additions to documentation
Milestone

Comments

@kral2
Copy link
Contributor

kral2 commented Sep 7, 2021

Community Note

  • Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
  • Please do not leave "+1" or "me too" comments, they generate extra noise for issue followers and do not help prioritize the request
  • If you are interested in working on this issue or have submitted a pull request, please leave a comment

Affected Resource(s)

Quickstart.doc and any other AsciiDoc document in this repo that use include:: is not rendered properly.

This is initially used to include code snippets without having to duplicate information, but GitHub security parameters prevent it. This is a known limitation of AsciiDoc when used on GitHub: github/markup#1095

Proposed fix

as the includes in the quickstart is mainly used for complete doc inclusion, we should replace the include:: with a link to the file in the repository.

@kral2 kral2 added the bug Something isn't working label Sep 7, 2021
@kral2 kral2 added this to the 3.1.0 milestone Sep 8, 2021
@kral2 kral2 modified the milestones: 3.1.0, future Oct 21, 2021
@kral2 kral2 added the documentation Improvements or additions to documentation label Oct 27, 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 documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant