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

doc: rewrote the iscsi-target-cli installation #23190

Merged
merged 1 commit into from
Nov 3, 2018

Conversation

maxcuttins
Copy link
Contributor

Rewrote the documentation in a step-by-step style, reformatted using RST's titles instead of bolds, added installation of GIT if needed, added installation of compilers needed for tcmu-runner

Signed-off-by: Massimiliano Cuttini massimiliano.cuttini@phoenixweb.it

@dillaman
Copy link

jenkins render docs

@ceph-jenkins
Copy link
Collaborator

Doc render available at http://docs.ceph.com/ceph-prs/23190/

doc/rbd/iscsi-target-cli-manual-install.rst Outdated Show resolved Hide resolved
doc/rbd/iscsi-target-cli-manual-install.rst Outdated Show resolved Hide resolved
doc/rbd/iscsi-target-cli-manual-install.rst Outdated Show resolved Hide resolved
doc/rbd/iscsi-target-cli-manual-install.rst Outdated Show resolved Hide resolved
doc/rbd/iscsi-target-cli-manual-install.rst Outdated Show resolved Hide resolved
doc/rbd/iscsi-target-cli-manual-install.rst Outdated Show resolved Hide resolved
doc/rbd/iscsi-target-cli-manual-install.rst Outdated Show resolved Hide resolved
doc/rbd/iscsi-target-cli-manual-install.rst Outdated Show resolved Hide resolved
doc/rbd/iscsi-target-cli-manual-install.rst Outdated Show resolved Hide resolved
doc/rbd/iscsi-target-cli-manual-install.rst Outdated Show resolved Hide resolved
@maxcuttins
Copy link
Contributor Author

make check failed?

@ceph-jenkins
Copy link
Collaborator

Doc render available at http://docs.ceph.com/ceph-prs/23190/

@maxcuttins
Copy link
Contributor Author

@dillaman I really don't know why "make checks" failed

@tchaikov
Copy link
Contributor

jenkins, retest this please

doc/rbd/iscsi-target-cli-manual-install.rst Show resolved Hide resolved
doc/rbd/iscsi-target-cli-manual-install.rst Outdated Show resolved Hide resolved
doc/rbd/iscsi-target-cli-manual-install.rst Outdated Show resolved Hide resolved
doc/rbd/iscsi-target-cli-manual-install.rst Outdated Show resolved Hide resolved
doc/rbd/iscsi-target-cli-manual-install.rst Outdated Show resolved Hide resolved
doc/rbd/iscsi-target-cli-manual-install.rst Outdated Show resolved Hide resolved
doc/rbd/iscsi-target-cli-manual-install.rst Outdated Show resolved Hide resolved
doc/rbd/iscsi-target-cli-manual-install.rst Outdated Show resolved Hide resolved
doc/rbd/iscsi-target-cli-manual-install.rst Outdated Show resolved Hide resolved
doc/rbd/iscsi-target-cli-manual-install.rst Outdated Show resolved Hide resolved
@stale
Copy link

stale bot commented Oct 17, 2018

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.
If you are a maintainer or core committer, please follow-up on this issue to identify what steps should be taken by the author to move this proposed change forward.
If you are the author of this pull request, thank you for your proposed contribution. If you believe this change is still appropriate, please ensure that any feedback has been addressed and ask for a code review.

@stale stale bot added the stale label Oct 17, 2018
@LenzGr
Copy link
Contributor

LenzGr commented Oct 18, 2018

Hi @maxcuttins thanks for your contribution - would it be possible for you to make the amendments requested by @dillaman so this PR can be merged?

@stale stale bot removed the stale label Oct 18, 2018
@ceph-jenkins
Copy link
Collaborator

Doc render available at http://docs.ceph.com/ceph-prs/23190/

@maxcuttins
Copy link
Contributor Author

maxcuttins commented Oct 18, 2018

Hi @maxcuttins thanks for your contribution - would it be possible for you to make the amendments requested by @dillaman so this PR can be merged?

To me it's a nightmare to apply these changes because my GIT try to solve many submodule/repos appear to be broken on my client. I just want to contribute to the DOC, but instead I face problem with make checks and other staff.

I update the doc from the online editor of github and seems fine.

However, next time, just modify directly.
To me was just fine update the big changes not right in the documentation but really I don't know all the internal redhat rules to write in your way. So, If I can suggest you a faster way to approve changes, I think that minor/formal reviews can be apply later by a second reviewer to have a uniform documentation.
This allow you to approve quickly big big big difference in the documentation that need to be updated as soon as possible. :)

@maxcuttins
Copy link
Contributor Author

News?

@LenzGr
Copy link
Contributor

LenzGr commented Oct 19, 2018

The documentation build check failed with the following error:

Warning, treated as error:
/home/jenkins-build/build/workspace/ceph-pr-docs/doc/rbd/iscsi-target-cli-manual-install.rst:68: (WARNING/2) Title underline too short.

Could you please correct this?

@LenzGr
Copy link
Contributor

LenzGr commented Oct 19, 2018

And yes, the process of updating the documentation is somewhat involved. Thanks for your endurance 👍 - did you see the chapter "Documenting Ceph" in the documentation? This should explain the process and expectations in more detail.

@LenzGr
Copy link
Contributor

LenzGr commented Oct 22, 2018

Thank you for fixing the latest failure. Unfortunately the "Signed-off-by" check fails - please make sure that commits are properly signed-off using git commit -s.

@dillaman OK to merge from your POV? Then I'd suggest @maxcuttins to squash all changes into a single commit before merging.

@LenzGr
Copy link
Contributor

LenzGr commented Oct 22, 2018

jenkins render docs

@ceph-jenkins
Copy link
Collaborator

Doc render available at http://docs.ceph.com/ceph-prs/23190/

@LenzGr
Copy link
Contributor

LenzGr commented Nov 2, 2018

@dillaman any thoughts on this change?

Rewrote the documentation in a step-by-step style, reformatted using RST's
titles instead of bolds, added installation of GIT if needed, added
installation of compilers needed for tcmu-runner

Signed-off-by: Massimiliano Cuttini <massimiliano.cuttini@phoenixweb.it>
@dillaman
Copy link

dillaman commented Nov 2, 2018

jenkins render docs

@ceph-jenkins
Copy link
Collaborator

Doc render available at http://docs.ceph.com/ceph-prs/23190/

@dillaman dillaman merged commit 8931f8c into ceph:master Nov 3, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
6 participants