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

Convert Specification to AsciiDoc from Markdown #333

Closed
msgilligan opened this issue Oct 25, 2019 · 3 comments
Closed

Convert Specification to AsciiDoc from Markdown #333

msgilligan opened this issue Oct 25, 2019 · 3 comments

Comments

@msgilligan
Copy link
Member

msgilligan commented Oct 25, 2019

In our weekly meetings, we've agreed that we want to convert the specification from markdown format to AsciiDoc(tor) format.

I've created a DRAFT pull request PR #329 to do this, but I wanted to have a little discussion about how best to merge the changes. I've also created PR #332 to convert the other documents in this repo.

The Omni Documentation repo is already in AsciiDoc format and Getting Started with Omni Development now includes a Working with Asciidoctor format section.

My proposal is that we do the following:

  1. Merge PR Convert the spec to AsciiDoc format #335
  2. Rebase the two outstanding PRs with Github-markdown formatted changes (PR Added Send All #313 and PR initial updates for OmniDex 2.0 #316) to the updated master branch.
  3. Add additional commits to PR Added Send All #313 and PR initial updates for OmniDex 2.0 #316 that convert the changes in the PR to AsciiDoc format.
  4. Merge PR Asciidoctor Github Action #329 To enable Github Actions to generate PDF and downloadable HTML versions of the Spec.

If consensus forms around this approach, I'll make it happen.

@CraigSellars @achamely @marvgmail @dexX7

@achamely
Copy link
Contributor

#332 looks good to me and i'm on board with this approach

@msgilligan
Copy link
Member Author

OK, PR #335 is merged.
PR #329 is ready for review/merge.
And I've submitted a PR to @marvgmail to update is OmniDex 2 PR to AsciiDoc format.

@msgilligan
Copy link
Member Author

The conversion is complete. Additional work remains to get PR #313 and PR #316 merged, but we don't need this issue open to track that.

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

No branches or pull requests

2 participants