Skip to content
This repository was archived by the owner on Mar 25, 2018. It is now read-only.

Documentation for Rackspace Cloud DNS#134

Closed
etoews wants to merge 1 commit into
jclouds:masterfrom
rackerlabs:rax-dns
Closed

Documentation for Rackspace Cloud DNS#134
etoews wants to merge 1 commit into
jclouds:masterfrom
rackerlabs:rax-dns

Conversation

@etoews

@etoews etoews commented Apr 28, 2013

Copy link
Copy Markdown
Member

No description provided.

@buildhive

Copy link
Copy Markdown

Adrian Cole » jclouds.github.com #15 SUCCESS
This pull request looks good
(what's this?)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Why do the examples use a combination of ant and maven? This could be simpler.

@mattstep

Copy link
Copy Markdown
Member

This quickstart guide has some general rot in it, you should clean this document up. Terms are off, examples seem overly complex, and there are pre sections that appear untenable.
Please make sure you look through http://www.jclouds.org/documentation/quickstart/rackspace/ instead of just looking at the markdown in github, the xml samples are all broken right now.
@silkysun knows how to fix those.

@etoews

etoews commented Apr 28, 2013

Copy link
Copy Markdown
Member Author

@silkysun Do you have some suggestions on how to fix the code samples? I've tried the triple backtick thing (e.g. ```xml) but as you can see from http://www.jclouds.org/documentation/quickstart/rackspace/ it doesn't want to work with GitHub pages. The pre sections with the highlight do a proper job of formatting and highlighting the code so it looks good but there's too much space around the sample. Perhaps embedding a gist is the way to go? Thoughts?

Also does BuildHive publish the pages somewhere? I run my docs through jekyll but it doesn't always seem to be one-to-one with what winds up on jclouds.org.

@mattstep

Copy link
Copy Markdown
Member

@everett-toews jekyll works great for me and shows these problems.

@etoews

etoews commented Apr 29, 2013

Copy link
Copy Markdown
Member Author

Tracking issue for Ant/Maven stuff in jclouds/jclouds-examples#35

@silkysun

silkysun commented May 2, 2013

Copy link
Copy Markdown
Member

@everett-toews I'm working on this. I should have more for you later this afternoon or tomorrow. Thanks for your patience!

@silkysun

silkysun commented May 6, 2013

Copy link
Copy Markdown
Member

@everett-toews I apologize for this delayed response. This weekend got very busy for me, and I lost track of time.

Have you tried removing the pre tags around your xml snippets?

Please look at the Maven doc for examples of xml snippets that render correctly. https://raw.github.com/jclouds/jclouds.github.com/master/documentation/userguide/using-maven.md

@etoews etoews closed this May 15, 2013
@etoews

etoews commented May 15, 2013

Copy link
Copy Markdown
Member Author

Will address these comments in separate PRs.

@etoews

etoews commented May 19, 2013

Copy link
Copy Markdown
Member Author

@mattstep Not sure if you noticed but I addressed your comments from this pull request in PR #141 a few days ago.

Switching to Maven was really useful. It also eliminated the need for the XML samples. Thanks for your review. And sorry about the timing of it all. I got pretty sick after I submitted this PR and I should have communicated the fact that I was down and out.

@mattstep

Copy link
Copy Markdown
Member

No worries dude. Thanks for addressing!
On May 19, 2013 3:03 PM, "Everett Toews" notifications@github.com wrote:

@mattstep https://github.com/mattstep Not sure if you noticed but I
addressed your comments from this pull request in PR #141https://github.com/jclouds/jclouds.github.com/issues/141a few days ago.

Switching to Maven was really useful. It also eliminated the need for the
XML samples. Thanks for your review. And sorry about the timing of it all.
I got pretty sick after I submitted this PR and I should have communicated
the fact that I was down and out.


Reply to this email directly or view it on GitHubhttps://github.com//pull/134#issuecomment-18125587
.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants