-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Asciidoc documentation into 2.x #1956
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
Conversation
When writing out the ExpectJson accessor value, compile an assembly from the anonymous type string in order to serialize the type and get the json for it. Temporarily checked in AsciiDoc assembly - will release something to MyGet/Nuget for this when MVP is done (e.g. Tables are not yet handled) Lowercase and hyphenate all files
Support Callouts in documentation Tidy up names of generated asciidoc files Start bringing in usage documentation
Apply conventions to add a section title for Fluent DSL, Object Initializer Syntax and Handling Responses source code blocks
Move example json to below the initializer example Ensure level 2 Section titles have an anchor generated
…hod block Generate a Section Title and anchor if an asciidoc does not have one
remove named attribute method - the doc generation process expects a linenumbering attribute in index 2 of a source block's attributes.
Asciidoc seems to be picky about wanting the trailing slash in the attribute entry as opposed to being part of the image link
Fix indentation when the first character following the first set of tabs is an opening brace. This is a bit of a hack. there may be a nicer way of doing this but it works fine for the moment. Add Aggs vs Aggregations section
# Conflicts: # src/Tests/Aggregations/Bucket/Filter/FilterAggregationUsageTests.cs
🎈 🎉 🎆 🍰 Decent docs! Only 4 years in the making 😄 This new documentation that'll be part of elastic.co is gonna rock! Functionally everything looks good to me to merge however I have some prerequisites before merging this into the
|
Awesome work @russcam !
Would just rebasing against 2.x then squashing to a single commit be the same thing? |
that would not get rid of the merge commits with 2.x AFAIK |
Unnecessary for both viewing asciidocs and generating documentation
Happy to release to github under an org we can all work on it on - just letting you know it's a little messy in places. Feel free to slash and burn 😄 I'll cherry pick the commits out and squash them into one commit for the PR 👍 |
Closing to open a cherry-picked PR 👍 |
The feature/documentation branch is in a position where it would provide value to appear on the elastic docs site for the 2.x client, on a progession over perfection basis. A summary of the changes:
src/lib/dnx451
. I will put this up on github and publish to nuget to reference from there when it is good for alpha (it works for our current purposes but is limited and can only output asciidocs for the moment). This library is used to modify the asciidocs generated from literate tests to perform such actions as adding attribute entries, section titles for usage pages, etc../build_docs.pl --doc ~/docs/asciidoc/index.asciidoc
where
~
is the project rootClientConcepts/HighLevel/Inference
, and moved the files to the new directory