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

650 ascii doc #737

Merged
merged 6 commits into from
Apr 25, 2020
Merged

650 ascii doc #737

merged 6 commits into from
Apr 25, 2020

Conversation

jan-goral
Copy link
Contributor

@jan-goral jan-goral commented Apr 24, 2020

Fixes #650

Checklist

  • release_notes.md updated

@jan-goral jan-goral self-assigned this Apr 24, 2020
@jan-goral jan-goral added this to the May 2020 milestone Apr 24, 2020
@jan-goral jan-goral linked an issue Apr 24, 2020 that may be closed by this pull request
tasks.assemble {
dependsOn(tasks.asciidoctor)
}
// end --- ASCII doc generation ---
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image
let's end with a newline :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ahh sorry. No more missing newlines, finally I checked Ensure line feed at file end on save in IDE.

@bootstraponline
Copy link
Contributor

The html files look great. We probably want to figure out a way to publish them. I had two ideas. One is githack.com and the other is github pages.

We could an index page and then linking that from the readme using https://raw.githack.com/ so that it's easy to view the HTML files.

https://rawcdn.githack.com/Flank/flank/51c89128921c8ff39c4b165acc496ef606d1a6d3/test_runner/docs/html5/flank.jar_-android-doctor.html

Another idea is to use github pages and push the html files to a gh-pages branch
https://help.github.com/en/github/working-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site

@bootstraponline
Copy link
Contributor

bootstraponline commented Apr 24, 2020

If GitHub.com natively renders asciidoc then maybe that’s a better in repo format than HTML.

@jan-goral
Copy link
Contributor Author

Ok, I'll check these options

@codecov-io
Copy link

Codecov Report

Merging #737 into master will decrease coverage by 1.20%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff              @@
##             master     #737      +/-   ##
============================================
- Coverage     79.42%   78.22%   -1.21%     
- Complexity      666      676      +10     
============================================
  Files           113      125      +12     
  Lines          2698     2787      +89     
  Branches        386      402      +16     
============================================
+ Hits           2143     2180      +37     
- Misses          307      348      +41     
- Partials        248      259      +11     

@jan-goral
Copy link
Contributor Author

If GitHub.com natively renders asciidoc then maybe that’s a better in repo format than HTML.

ASCIIdoc looks nice and works out of the box. Good effect without effort. 👍

@jan-goral jan-goral marked this pull request as ready for review April 24, 2020 20:11
@bootstraponline
Copy link
Contributor

looks excellent! ⭐

@jan-goral jan-goral merged commit b47f33f into master Apr 25, 2020
@jan-goral jan-goral deleted the 650-ascii-doc branch April 25, 2020 01:08
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.

Flank ASCII doc
3 participants