Closed KPull closed 7 years ago
Since I'm nearing completion of the document, I invite you to start proof-reading. If you find anything wrong (typos) you should be able to edit/commit directly on my branch using GitHub.
Pinging: @maria-camenzuli, @FrelliBB, @chiarafsc, @benjie332, @ericathedev, @ericathedev
Ok, I think we can go with this guide @maria-camenzuli @FrelliBB @chiarafsc! There's not need to review the generated files obviously. Some problems:
UserGuideTest
as @Ignore
for now because of a problem making the "proxy" HTTP client work with the timeout functionality. The test is still used as a source of examples though.pom.xml
file so that the documentation files are generated in a profile called documentation
: this is because the Kotlin script used to generate the files needs us to add a separate dependency for the standard library. I reported this issue in: https://youtrack.jetbrains.com/oauth?state=%2Fissue%2FKT-15454I'll leave this pull request open till Wednesday next week after which I'll merge. Since the manual is quite large, don't worry if we don't get it perfect right away. It'll get better as we make improvements to it in the long run. ;)
In this pull request, I add a reference manual for Bastion. Some things to keep in mind:
overview.adoc
at the moment using AsciiDoc.mvn generate-resources
to generate the manual intooverview.html
./docs
folder so that we can use GitHub pages to host it on the web.This pull request is not yet ready for merging!