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

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

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

eriwen
Copy link

@eriwen eriwen commented Mar 1, 2019

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

This change introduces Asciidoctor, Asciidoctor extensions, and
Exemplar to generate a docs/ site with a mini-guide for each
sample.
@eriwen eriwen requested a review from lacasseio March 1, 2019 00:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant