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

docs: Adds Asciidoc generation to "make docs" #249

Merged
merged 4 commits into from
Apr 5, 2020

Conversation

marclop
Copy link
Collaborator

@marclop marclop commented Apr 3, 2020

Description

Adds a script which generates .adoc files from the existing markdown
generated files in the docs/ folder via kramdoc.

Additionally, adds a comment to the deployment create source file so that
the .adoc file doesn't change and break the build.

Related Issues

Resolves #245

Motivation and Context

Auto-generated Asciidoc files!

How Has This Been Tested?

Running make docs:

$ make docs
-> Deleting docs...
-> Regenerating Markdown...
-> Regenerating Asciidoc...
-> Detected 1 format changes, please add them to your commit
make[1]: *** [check-changes] Error 1
make: *** [docs] Error 2

Types of Changes

  • Documentation

Adds a script which generates `.adoc` files from the existing markdown
generated files in the `docs/` folder via `kramdoc`.

Signed-off-by: Marc Lopez <marc5.12@outlook.com>
@marclop marclop added documentation Improvements or additions to documentation loe:small labels Apr 3, 2020
@marclop marclop added this to the 38: Mar 18 - Apr 7 milestone Apr 3, 2020
@marclop marclop requested a review from a team as a code owner April 3, 2020 08:59
@marclop marclop self-assigned this Apr 3, 2020
Signed-off-by: Marc Lopez <marc5.12@outlook.com>
Signed-off-by: Marc Lopez <marc5.12@outlook.com>
Signed-off-by: Marc Lopez <marc5.12@outlook.com>
Copy link
Contributor

@karencfv karencfv left a comment

Choose a reason for hiding this comment

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

NIce! ✨ Thanks for getting this done so quickly!

@nrichers what do you think? are we missing anything here?

cmd/deployment/create_help.go Show resolved Hide resolved
@marclop
Copy link
Collaborator Author

marclop commented Apr 5, 2020

Added a comment on the ESS Public API Meta issue

@marclop marclop merged commit 3e9e5bf into elastic:master Apr 5, 2020
@nrichers
Copy link
Contributor

nrichers commented Apr 6, 2020

Hiya. I didn't get a chance to review this over the weekend, but this looks awesome! Thank you so much for adding these changes. ❤️

@karencfv
Copy link
Contributor

karencfv commented Apr 6, 2020

🙈 sorry @nrichers. I forgot our Monday is your Sunday

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: Add asciidoc generation to workflow
3 participants