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

Converted all .asciidoc to .md. #658

Merged
merged 1 commit into from
May 5, 2021

Conversation

dblock
Copy link
Member

@dblock dblock commented May 5, 2021

Signed-off-by: dblock dblock@amazon.com

Description

While some of us do love asciidoc for its many claimed awesome features over markdown, none of those features seem to work in "safe" modes, such as GitHub. In such, we are effectively committing documents that are hard to read or unreadable on GitHub. It's time to standardize to the most widely adopted and least common denominator, GitHub-flavored markdown.

For the technically inclined this is what I followed these instructions:

  1. Convert to .xml with asciidoc -b docbook TESTING.asciidoc.
  2. Fix any errors in asciidoc above that asciidoc spews.
  3. Convert xml to markdown, pandoc -f docbook -t markdown_strict TESTING.xml -o TESTING.md.
  4. Cleanup markdown, such as 80-column layout, some syntax highlighting, add TOC, etc.

Check List

--[x] Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@opensearch-ci-bot
Copy link
Collaborator

✅   DCO Check Passed 3f0c4b0be51ed1aa936e029649f04940d57822ba

@opensearch-ci-bot
Copy link
Collaborator

✅   Gradle Wrapper Validation success 3f0c4b0be51ed1aa936e029649f04940d57822ba

Signed-off-by: dblock <dblock@amazon.com>
@@ -1 +0,0 @@
CHANGELOG.asciidoc merge=union
Copy link
Member Author

Choose a reason for hiding this comment

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

I couldn't find a CHANGELOG.asciidoc, so ...

Copy link
Member

Choose a reason for hiding this comment

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

Huhn. That's weird. Vestigial I guess?

Copy link
Contributor

Choose a reason for hiding this comment

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

It was added here 3e7fccd and then removed here 0f85c64

@opensearch-ci-bot
Copy link
Collaborator

✅   Gradle Wrapper Validation success 3e015c9

@opensearch-ci-bot
Copy link
Collaborator

✅   DCO Check Passed 3e015c9

@opensearch-ci-bot
Copy link
Collaborator

✅   Gradle Precommit success 3f0c4b0be51ed1aa936e029649f04940d57822ba

@opensearch-ci-bot
Copy link
Collaborator

✅   Gradle Precommit success 3e015c9

Copy link
Member

@CEHENKLE CEHENKLE left a comment

Choose a reason for hiding this comment

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

Thanks for doing this :)

@@ -1 +0,0 @@
CHANGELOG.asciidoc merge=union
Copy link
Member

Choose a reason for hiding this comment

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

Huhn. That's weird. Vestigial I guess?

@adnapibar
Copy link
Contributor

start gradle check

@opensearch-ci-bot
Copy link
Collaborator

✅   Gradle Check success 3e015c9
Log 162

Reports 162

@dblock dblock merged commit 6d1e6a0 into opensearch-project:main May 5, 2021
dblock added a commit that referenced this pull request May 6, 2021
Signed-off-by: dblock <dblock@amazon.com>
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.

4 participants