terraform-oci-vcn
terraform-oci-vcn copied to clipboard
GitHub do not render asciidoc `include` directive
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: https://github.com/github/markup/issues/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.