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

Asciidoc conversion #456

Merged
11 commits merged into from Aug 29, 2018
Merged

Asciidoc conversion #456

11 commits merged into from Aug 29, 2018

Conversation

rkratky
Copy link

@rkratky rkratky commented Aug 14, 2018

What does this PR do?

Converts the entire bulk of docs from Markdown to Asciidoc(tor). The linked issue (#425) contains detailed explanation and reasoning for the conversion.

Jekyll is still used to generate the site, and the site's design and navigation elements are unchanged. I viewed every single page on the site to check for problems. If you find any, I'll fix them.

The PR includes:

  • converted docs source files
  • various fixes necessitated by invalid Markdown syntax
  • updated Jekyll build system (run.sh, _config.yml, Gemfile)
  • Dockerfile for building the image for local building & serving of the site (the image has also been pushed to Docker Hub, so no local building of the image is required; the run.sh script pulls this new image)

The only (quite minor) change is the syntax highlighter used for source-code listings. I couldn't get the currently used one (Rouge) to work, so I used a different one (Coderay). Syntax is still properly highlighted, only the colors used are a tiny bit different.

What issues does this PR fix or reference?

#425 (Convert docs to AsciiDoc)

@rkratky rkratky requested a review from bmicklea as a code owner August 14, 2018 13:49
@rkratky rkratky requested a review from a user August 14, 2018 13:49
@rkratky rkratky requested a review from slemeur as a code owner August 14, 2018 13:49
@ghost
Copy link

ghost commented Aug 14, 2018

@rkratky I can't find pom.xml in the PR - have you changed Docker image here too? https://github.com/eclipse/che-docs/blob/master/pom.xml#L68

@rkratky
Copy link
Author

rkratky commented Aug 14, 2018

@eivantsov

I can't find pom.xml in the PR - have you changed Docker image here too? https://github.com/eclipse/che-docs/blob/master/pom.xml#L68

That I forgot. I will fix that. (What is it used for?)

Robert Krátký added 8 commits August 14, 2018 17:22
Signed-off-by: Robert Krátký <rkratky@redhat.com>
Signed-off-by: Robert Krátký <rkratky@redhat.com>
Signed-off-by: Robert Krátký <rkratky@redhat.com>
Signed-off-by: Robert Krátký <rkratky@redhat.com>
Signed-off-by: Robert Krátký <rkratky@redhat.com>
Signed-off-by: Robert Krátký <rkratky@redhat.com>
Signed-off-by: Robert Krátký <rkratky@redhat.com>
Signed-off-by: Robert Krátký <rkratky@redhat.com>
@rkratky
Copy link
Author

rkratky commented Aug 14, 2018

Apologies for the repeated push -- I keep forgetting to sign off on commits.

@ghost
Copy link

ghost commented Aug 15, 2018

Well, this is a maven project, and docs are packaged as war artifact that is then packaged into Che server.

@slemeur
Copy link
Contributor

slemeur commented Aug 16, 2018

+1 for the pom.xml

@rkratky
Copy link
Author

rkratky commented Aug 17, 2018

Thanks, I updated pom.xml.

@ghost
Copy link

ghost commented Aug 21, 2018

@rkratky can you please resolve conflicts and merge asap?

Signed-off-by: Robert Krátký <rkratky@redhat.com>
@rkratky
Copy link
Author

rkratky commented Aug 26, 2018

@eivantsov Apologies for the delay, I was on PTO.

The conflicts are resolved, please merge.

Robert Krátký added 2 commits August 26, 2018 19:00
Signed-off-by: Robert Krátký <rkratky@redhat.com>
Signed-off-by: Robert Krátký <rkratky@redhat.com>
@ghost ghost merged commit 234ffc2 into eclipse-che:master Aug 29, 2018
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants