[ https://issues.apache.org/jira/browse/BEAM-751?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Frances Perry updated BEAM-751: ------------------------------- Issue Type: Improvement (was: Bug) > infrastructure for extracting code snippets into documentation > -------------------------------------------------------------- > > Key: BEAM-751 > URL: https://issues.apache.org/jira/browse/BEAM-751 > Project: Beam > Issue Type: Improvement > Components: website > Reporter: Frances Perry > Assignee: James Malone > Labels: starter > > As we fill in more and more documentation, the number of code snippets is > going to drastically increase, and we should ensure the quality of those > snippets by automatically extracting them from code that is regularly > compiled and tested. > Goals: > * automatically extract code snippets from incubator-beam for use in the beam > website documentation > * use stable references so folks editing the code can clearly tell what > documentation changes this will result in (good: specially formatted comment, > bad: line number) > * freshness (is live possible? or at least during the general 'jekyll build' > phase?) > The best we've found so far is using jekyll-gist with gist-it, but that would > rely on fragile line numbers. -- This message was sent by Atlassian JIRA (v6.3.4#6332)