native-samples icon indicating copy to clipboard operation
native-samples copied to clipboard

Bootstrap use of common Gradle docs infrastructure for a native-samples site

Open eriwen opened this issue 6 years ago • 0 comments

Context

The idea is that we can replace the README.md with an index.adoc with each sample. Asciidoctor extensions and Exemplar would be used for common functionality such as multi-language samples (like those on docs.gradle.org) and testing through Exemplar.

There are a bunch of gaps here:

  • It does not generate a separate page per sample. We want it to generate docs/cpp/application/index.html and not docs/index.html.
  • Embedded sample tests run with :test, but Exemplar seems to be looking in the wrong place to run samples right now. Also everything is hard-coded for just 1 sample right now.
  • The CSS and JS are missing so the generated output doesn't look good yet
  • We want to use a CNAME file and DNS such that https://native-samples.gradle.org/cpp/application/ would be the final URL that we'd link to from gradle.org/guides

Contributor Checklist

eriwen avatar Mar 01 '19 00:03 eriwen