[PATCH 0/3] Documentation improvements
From: Leonardo Garcia <lagarcia@br.ibm.com> Leonardo Garcia (3): Add hypervisor information on README.md. Limit README.md to 80 columns. Add mailing list information. CONTRIBUTE.md | 6 +++--- docs/README.md | 31 +++++++++++++++++++++++-------- 2 files changed, 26 insertions(+), 11 deletions(-) -- 1.8.5.3
From: Leonardo Garcia <lagarcia@br.ibm.com> Signed-off-by: Leonardo Garcia <lagarcia@br.ibm.com> --- docs/README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/README.md b/docs/README.md index 9c7c188..8433a69 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,6 +4,10 @@ Kimchi Project Kimchi is an HTML5 based management tool for KVM. It is designed to make it as easy as possible to get started with KVM and create your first guest. +Kimchi runs as a daemon on the hypervisor. It manages KVM guests through +libvirt. The management interface is accessed through the web using an HTML5 +powered browser. + Browser Support =============== Desktop Browser Support: @@ -24,6 +28,15 @@ that preceded it. For example, if the current version of a browser is 24.x, we s 23.x versions.This does not mean that kimchi cannot be used in other browsers, however, functionality and appearance may be diminished and we may not be able to provide support for any problems you find. +Hypervisor Distro Support +============== + +Kimchi daemon might run on any GNU/Linux distribution that sufices the +conditions described on the 'Getting Started' section below. + +However, the Kimchi community is usually making tests with the latest version of +Fedora, RHEL, OpenSuSe, and Ubuntu. + Getting Started =============== -- 1.8.5.3
Missing commit message On 02/10/2014 12:35 AM, Leonardo Garcia wrote:
From: Leonardo Garcia <lagarcia@br.ibm.com>
Signed-off-by: Leonardo Garcia <lagarcia@br.ibm.com> --- docs/README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+)
diff --git a/docs/README.md b/docs/README.md index 9c7c188..8433a69 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,6 +4,10 @@ Kimchi Project Kimchi is an HTML5 based management tool for KVM. It is designed to make it as easy as possible to get started with KVM and create your first guest.
+Kimchi runs as a daemon on the hypervisor. It manages KVM guests through +libvirt. The management interface is accessed through the web using an HTML5 +powered browser. + Browser Support =============== Desktop Browser Support: @@ -24,6 +28,15 @@ that preceded it. For example, if the current version of a browser is 24.x, we s 23.x versions.This does not mean that kimchi cannot be used in other browsers, however, functionality and appearance may be diminished and we may not be able to provide support for any problems you find.
+Hypervisor Distro Support +============== + +Kimchi daemon might run on any GNU/Linux distribution that sufices the +conditions described on the 'Getting Started' section below. + +However, the Kimchi community is usually making tests with the latest version of +Fedora, RHEL, OpenSuSe, and Ubuntu. + Getting Started ===============
Some suggestions below. :) On Mon, 2014-02-10 at 00:35 -0200, Leonardo Garcia wrote:
From: Leonardo Garcia <lagarcia@br.ibm.com>
Signed-off-by: Leonardo Garcia <lagarcia@br.ibm.com> --- docs/README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+)
diff --git a/docs/README.md b/docs/README.md index 9c7c188..8433a69 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,6 +4,10 @@ Kimchi Project Kimchi is an HTML5 based management tool for KVM. It is designed to make it as easy as possible to get started with KVM and create your first guest.
+Kimchi runs as a daemon on the hypervisor. It manages KVM guests through "on the hypervisor host" (since it doesn't run *on* the actual hypervisor) +libvirt. The management interface is accessed through the web using an HTML5 +powered browser. "is accessed over the web using a browser that supports HTML5." + Browser Support =============== Desktop Browser Support: @@ -24,6 +28,15 @@ that preceded it. For example, if the current version of a browser is 24.x, we s 23.x versions.This does not mean that kimchi cannot be used in other browsers, however, functionality and appearance may be diminished and we may not be able to provide support for any problems you find.
+Hypervisor Distro Support +============== + +Kimchi daemon might run on any GNU/Linux distribution that sufices the Instead of suffices, use "meets."
+conditions described on the 'Getting Started' section below. + +However, the Kimchi community is usually making tests with the latest version of "The Kimchi community makes an effort to test with the latest versions of" +Fedora, RHEL, OpenSuSe, and Ubuntu. + Getting Started ===============
On 02/10/2014 10:14 PM, Christy Perez wrote:
Some suggestions below. :) Thanks, Christy! Always good to have a native speaker going through what we write. :)
Best regards, Leonardo Garcia
On Mon, 2014-02-10 at 00:35 -0200, Leonardo Garcia wrote:
From: Leonardo Garcia <lagarcia@br.ibm.com>
Signed-off-by: Leonardo Garcia <lagarcia@br.ibm.com> --- docs/README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+)
diff --git a/docs/README.md b/docs/README.md index 9c7c188..8433a69 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,6 +4,10 @@ Kimchi Project Kimchi is an HTML5 based management tool for KVM. It is designed to make it as easy as possible to get started with KVM and create your first guest.
+Kimchi runs as a daemon on the hypervisor. It manages KVM guests through "on the hypervisor host" (since it doesn't run *on* the actual hypervisor) +libvirt. The management interface is accessed through the web using an HTML5 +powered browser. "is accessed over the web using a browser that supports HTML5." + Browser Support =============== Desktop Browser Support: @@ -24,6 +28,15 @@ that preceded it. For example, if the current version of a browser is 24.x, we s 23.x versions.This does not mean that kimchi cannot be used in other browsers, however, functionality and appearance may be diminished and we may not be able to provide support for any problems you find.
+Hypervisor Distro Support +============== + +Kimchi daemon might run on any GNU/Linux distribution that sufices the Instead of suffices, use "meets."
+conditions described on the 'Getting Started' section below. + +However, the Kimchi community is usually making tests with the latest version of "The Kimchi community makes an effort to test with the latest versions of" +Fedora, RHEL, OpenSuSe, and Ubuntu. + Getting Started ===============
_______________________________________________ Kimchi-devel mailing list Kimchi-devel@ovirt.org http://lists.ovirt.org/mailman/listinfo/kimchi-devel
From: Leonardo Garcia <lagarcia@br.ibm.com> Signed-off-by: Leonardo Garcia <lagarcia@br.ibm.com> --- docs/README.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/docs/README.md b/docs/README.md index 8433a69..23b7969 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,8 +1,8 @@ Kimchi Project ============== -Kimchi is an HTML5 based management tool for KVM. It is designed to make it -as easy as possible to get started with KVM and create your first guest. +Kimchi is an HTML5 based management tool for KVM. It is designed to make it as +easy as possible to get started with KVM and create your first guest. Kimchi runs as a daemon on the hypervisor. It manages KVM guests through libvirt. The management interface is accessed through the web using an HTML5 @@ -23,10 +23,12 @@ Mobile Browser Support: * **Safari iOS:** Current-1 version * **Android Browser** Current-1 version -Current-1 version denotes that we support the current stable version of the browser and the version -that preceded it. For example, if the current version of a browser is 24.x, we support the 24.x and -23.x versions.This does not mean that kimchi cannot be used in other browsers, however, functionality -and appearance may be diminished and we may not be able to provide support for any problems you find. +Current-1 version denotes that we support the current stable version of the +browser and the version that preceded it. For example, if the current version of +a browser is 24.x, we support the 24.x and 23.x versions.This does not mean that +kimchi cannot be used in other browsers, however, functionality and appearance +may be diminished and we may not be able to provide support for any problems you +find. Hypervisor Distro Support ============== @@ -91,8 +93,8 @@ for more information on how to configure your system to access this repository. Packages version requirement: python-psutil >= 0.6.0 -*Note for openSUSE users*: Some of the above packages are located in the openSUSE -Systems Management repository. See +*Note for openSUSE users*: Some of the above packages are located in the +openSUSE Systems Management repository. See [this FAQ](http://download.opensuse.org/repositories/systemsmanagement:/spacewalk/) to get the correct repository based on your openSUSE version. And [this FAQ](http://en.opensuse.org/SDB:Add_package_repositories) for more -- 1.8.5.3
Missing commit message On 02/10/2014 12:35 AM, Leonardo Garcia wrote:
From: Leonardo Garcia <lagarcia@br.ibm.com>
Signed-off-by: Leonardo Garcia <lagarcia@br.ibm.com> --- docs/README.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-)
diff --git a/docs/README.md b/docs/README.md index 8433a69..23b7969 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,8 +1,8 @@ Kimchi Project ==============
-Kimchi is an HTML5 based management tool for KVM. It is designed to make it -as easy as possible to get started with KVM and create your first guest. +Kimchi is an HTML5 based management tool for KVM. It is designed to make it as +easy as possible to get started with KVM and create your first guest.
Kimchi runs as a daemon on the hypervisor. It manages KVM guests through libvirt. The management interface is accessed through the web using an HTML5 @@ -23,10 +23,12 @@ Mobile Browser Support: * **Safari iOS:** Current-1 version * **Android Browser** Current-1 version
-Current-1 version denotes that we support the current stable version of the browser and the version -that preceded it. For example, if the current version of a browser is 24.x, we support the 24.x and -23.x versions.This does not mean that kimchi cannot be used in other browsers, however, functionality -and appearance may be diminished and we may not be able to provide support for any problems you find. +Current-1 version denotes that we support the current stable version of the +browser and the version that preceded it. For example, if the current version of +a browser is 24.x, we support the 24.x and 23.x versions.This does not mean that +kimchi cannot be used in other browsers, however, functionality and appearance +may be diminished and we may not be able to provide support for any problems you +find.
Hypervisor Distro Support ============== @@ -91,8 +93,8 @@ for more information on how to configure your system to access this repository. Packages version requirement: python-psutil >= 0.6.0
-*Note for openSUSE users*: Some of the above packages are located in the openSUSE -Systems Management repository. See +*Note for openSUSE users*: Some of the above packages are located in the +openSUSE Systems Management repository. See [this FAQ](http://download.opensuse.org/repositories/systemsmanagement:/spacewalk/) to get the correct repository based on your openSUSE version. And [this FAQ](http://en.opensuse.org/SDB:Add_package_repositories) for more
From: Leonardo Garcia <lagarcia@br.ibm.com> Signed-off-by: Leonardo Garcia <lagarcia@br.ibm.com> --- CONTRIBUTE.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md index 327c37e..f4dcaec 100644 --- a/CONTRIBUTE.md +++ b/CONTRIBUTE.md @@ -1,9 +1,9 @@ How to Contribute ================= -All development discussion happens on the mailing list. All development is -done using the `git` SCM. Patches should be sent using the `git send-email` -command. +All development discussion happens on the mailing list. All development is done +using the `git` SCM. Patches should be sent using the `git send-email` command +to the kimchi-devel@ovirt.org mailing list. Good examples of how to send patches are included in [QEMU SubmitAPatch](http://wiki.qemu.org/Contribute/SubmitAPatch) and -- 1.8.5.3
Missing commit message On 02/10/2014 12:35 AM, Leonardo Garcia wrote:
From: Leonardo Garcia <lagarcia@br.ibm.com>
Signed-off-by: Leonardo Garcia <lagarcia@br.ibm.com> --- CONTRIBUTE.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md index 327c37e..f4dcaec 100644 --- a/CONTRIBUTE.md +++ b/CONTRIBUTE.md @@ -1,9 +1,9 @@ How to Contribute =================
-All development discussion happens on the mailing list. All development is -done using the `git` SCM. Patches should be sent using the `git send-email` -command. +All development discussion happens on the mailing list. All development is done +using the `git` SCM. Patches should be sent using the `git send-email` command +to the kimchi-devel@ovirt.org mailing list.
Good examples of how to send patches are included in [QEMU SubmitAPatch](http://wiki.qemu.org/Contribute/SubmitAPatch) and
Sorry, I may be new here and don't know exactly what you want. The commit message has only one simple line and is in the subject of the e-mail. This is a rather simple patch that only adds mailing list information to the CONTRIBUTE.md file. Unless you want me to just repeat the subject in the commit message body --- which I think is just a waste of time and space --- I don't see exactly what you want me to add here. Adding a commit message body just for the sake of having one does not make sense --- unless I will write something meaningful. Best regards, Leonardo Garcia On 02/10/2014 12:55 PM, Aline Manera wrote:
Missing commit message
On 02/10/2014 12:35 AM, Leonardo Garcia wrote:
From: Leonardo Garcia <lagarcia@br.ibm.com>
Signed-off-by: Leonardo Garcia <lagarcia@br.ibm.com> --- CONTRIBUTE.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md index 327c37e..f4dcaec 100644 --- a/CONTRIBUTE.md +++ b/CONTRIBUTE.md @@ -1,9 +1,9 @@ How to Contribute =================
-All development discussion happens on the mailing list. All development is -done using the `git` SCM. Patches should be sent using the `git send-email` -command. +All development discussion happens on the mailing list. All development is done +using the `git` SCM. Patches should be sent using the `git send-email` command +to the kimchi-devel@ovirt.org mailing list.
Good examples of how to send patches are included in [QEMU SubmitAPatch](http://wiki.qemu.org/Contribute/SubmitAPatch) and
On 02/10/2014 01:02 PM, Leonardo Augusto Guimarães Garcia wrote:
Sorry, I may be new here and don't know exactly what you want. The commit message has only one simple line and is in the subject of the e-mail. This is a rather simple patch that only adds mailing list information to the CONTRIBUTE.md file. Unless you want me to just repeat the subject in the commit message body --- which I think is just a waste of time and space --- I don't see exactly what you want me to add here. Adding a commit message body just for the sake of having one does not make sense --- unless I will write something meaningful.
Yeap! I mean for the commit description. All commits must have one. Usually we don't repeat the commit message in it, otherwise we explain why the patch is needed in addition to what it is for (if the commit message does not contain many details)
Best regards,
Leonardo Garcia
On 02/10/2014 12:55 PM, Aline Manera wrote:
Missing commit message
On 02/10/2014 12:35 AM, Leonardo Garcia wrote:
From: Leonardo Garcia <lagarcia@br.ibm.com>
Signed-off-by: Leonardo Garcia <lagarcia@br.ibm.com> --- CONTRIBUTE.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md index 327c37e..f4dcaec 100644 --- a/CONTRIBUTE.md +++ b/CONTRIBUTE.md @@ -1,9 +1,9 @@ How to Contribute =================
-All development discussion happens on the mailing list. All development is -done using the `git` SCM. Patches should be sent using the `git send-email` -command. +All development discussion happens on the mailing list. All development is done +using the `git` SCM. Patches should be sent using the `git send-email` command +to the kimchi-devel@ovirt.org mailing list.
Good examples of how to send patches are included in [QEMU SubmitAPatch](http://wiki.qemu.org/Contribute/SubmitAPatch) and
On 02/10/2014 01:09 PM, Aline Manera wrote:
On 02/10/2014 01:02 PM, Leonardo Augusto Guimarães Garcia wrote:
Sorry, I may be new here and don't know exactly what you want. The commit message has only one simple line and is in the subject of the e-mail. This is a rather simple patch that only adds mailing list information to the CONTRIBUTE.md file. Unless you want me to just repeat the subject in the commit message body --- which I think is just a waste of time and space --- I don't see exactly what you want me to add here. Adding a commit message body just for the sake of having one does not make sense --- unless I will write something meaningful.
Yeap! I mean for the commit description. All commits must have one. Usually we don't repeat the commit message in it, otherwise we explain why the patch is needed in addition to what it is for (if the commit message does not contain many details) Ok, I'll resend the patches...
Best regards,
Leonardo Garcia
On 02/10/2014 12:55 PM, Aline Manera wrote:
Missing commit message
On 02/10/2014 12:35 AM, Leonardo Garcia wrote:
From: Leonardo Garcia <lagarcia@br.ibm.com>
Signed-off-by: Leonardo Garcia <lagarcia@br.ibm.com> --- CONTRIBUTE.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md index 327c37e..f4dcaec 100644 --- a/CONTRIBUTE.md +++ b/CONTRIBUTE.md @@ -1,9 +1,9 @@ How to Contribute =================
-All development discussion happens on the mailing list. All development is -done using the `git` SCM. Patches should be sent using the `git send-email` -command. +All development discussion happens on the mailing list. All development is done +using the `git` SCM. Patches should be sent using the `git send-email` command +to the kimchi-devel@ovirt.org mailing list.
Good examples of how to send patches are included in [QEMU SubmitAPatch](http://wiki.qemu.org/Contribute/SubmitAPatch) and
participants (4)
-
Aline Manera -
Christy Perez -
Leonardo Augusto Guimarães Garcia -
Leonardo Garcia