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

Added documentation. #18

Merged
merged 3 commits into from
Jun 29, 2016
Merged

Added documentation. #18

merged 3 commits into from
Jun 29, 2016

Conversation

xor-xor
Copy link
Contributor

@xor-xor xor-xor commented Jun 22, 2016

@mkurek + @vi4m - please have a look at this PR. For your convenience, the rendered version of these docs is available here.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 60.627% when pulling 99bc792 on xor-xor:docs into 561ff48 on allegro:develop.

@xor-xor
Copy link
Contributor Author

xor-xor commented Jun 23, 2016

Regarding last commit ("turned off syntax highlighting"):

this:

screen shot 2016-06-23 at 09 49 25

vs. this:

screen shot 2016-06-23 at 09 50 23

(the latter is IMHO way better)

your iDRAC/iLO host, and save its result to Ralph (at this moment, it will be
limited only to MAC addresses, but that is going to change soon!).

## Getting ralph-cli binary
Copy link
Contributor

Choose a reason for hiding this comment

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

Please separate development and end user installation methods. glide should not be known for the EU.

Copy link
Contributor

Choose a reason for hiding this comment

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

s/Getting ralph-cli binary/Installation

The binary is not a task, but implementation detail

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Right. I'll separate these two.

Copy link

Choose a reason for hiding this comment

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

btw i'll consider naming this section 'Installation' (i know that downloading binary is not a installation per se, but it could be more familiar to the user when he'll see headers of the docs than 'Getting ralph-cli binary')

Copy link

Choose a reason for hiding this comment

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

about separating end user install and development install, IMO there should be separated page about development of (contributing to?) ralph cli.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, as I have mentioned previously, I'll separeate these two.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@vi4m + @mkurek - done.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 60.627% when pulling 7bc4f5e on xor-xor:docs into 561ff48 on allegro:develop.

@xor-xor
Copy link
Contributor Author

xor-xor commented Jun 27, 2016

@mkurek + @vi4m - is that allright with you now..?

@vi4m
Copy link
Contributor

vi4m commented Jun 28, 2016

LGTM

@mkurek
Copy link

mkurek commented Jun 29, 2016

🆗

@xor-xor xor-xor merged commit b515e77 into allegro:develop Jun 29, 2016
@xor-xor xor-xor deleted the docs branch July 1, 2016 14:17
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