Fix escaped angle bracket's in integration documentation.
There are several escaped angle brackets in our integration docs. While these render fine within GitLab, they are broken when rendered on doc.gitlab.com because pandoc does not escape them correctly.
You can see the problem here: http://doc.gitlab.com/ce/integration/github.html
Note that the strings <Organization>
and <Your Name>
are being interpreted as html tags.
It looks like doc.gitlab.com is using pandoc: https://gitlab.com/gitlab-com/doc-gitlab-com/blob/master/generate.rb#L64
You can verify these changes by running something like this and then inspecting test.html
:
pandoc --from markdown_github-hard_line_breaks -o test.html doc/integration/twitter.md
You can also verify that GitLab continues to render the docs correctly by checking, for example, http://localhost:3000/help/integration/twitter.md
Merge request reports
Activity
/cc @axil Please take a short look at this.
This means that every word like that's written like this<word>
in the docs won't be displayed on doc.gitlab.com.
Is it ok for you to merge this MR so we fix these occurences?To fix this completly maybe we can use the option
-raw-html
So our conversion command would read:html = `pandoc #{toc} --template #{template_path} --from markdown_github-hard_line_breaks-raw_html #{markdown_file}`
This would require a bit of testing to be sure nothing else breaks so this probably belongs to another MR, but it might be worth investigating this.
What do you think?@haynes yep, makes sense to fix it now and refactor later. Thanks for pinging! And thanks @ericidema for the MR :)
mentioned in commit b50e8c29
Mentioned in commit tnir/gitlab-ce@b50e8c29