Update developer doc by amarts · Pull Request #380 · gluster/glusterdocs

amarts · 2018-07-21T18:09:11Z

To reflect the latest changes in the project, and guidelines. This is not yet complete, but brings some level of sanity. Needs another round of polishing.

prashanthpai · 2018-07-23T02:35:56Z

@amarts Can you please fix the merge conflicts ?

sankarshanmukhopadhyay · 2018-07-23T02:49:28Z

Developer-guide/Backport-Guidelines.md

-fixed in the master branch, it might be desirable or necessary in a
-stable branch. To put the fix in the stable branch we need to backport the
-fix to the stable branch.
+As a policy, any new change, bug fix, etc., are to be fixed in 'master'


In the GlusterFS project, as a policy, any new change, bug fix etc are to be fixed in 'master'

sankarshanmukhopadhyay · 2018-07-23T02:52:01Z

Developer-guide/Backport-Guidelines.md

-## via Git command-line
-1.  Git clone the GlusterFS code
+* No feature from master would be backported to the release branch
+* Any CVE (aka, security alerts) on the existing releases would be backported, after getting fixed in master branch.


CVE ie. security vulnerability (listed on the CVE database)

sankarshanmukhopadhyay · 2018-07-23T02:53:07Z

Developer-guide/Backport-Guidelines.md

-1.  Git clone the GlusterFS code
+* No feature from master would be backported to the release branch
+* Any CVE (aka, security alerts) on the existing releases would be backported, after getting fixed in master branch.
+* Only severe issues, crashes, data loss, or unavailability issues would be backported to the release.


Only topics which bring about data loss or, unavailability would be backported to the release.

sankarshanmukhopadhyay · 2018-07-23T02:57:52Z

Developer-guide/Backport-Guidelines.md


-2.  Create and checkout a new branch for your work, based on the branch
-    for the backport version
+If your patch meets the criteria above, or you are an user, who prefer to have a fix backported, because your current setup is facing issues, below are the steps you need to take care to submit a patch on release branch.


sankarshanmukhopadhyay · 2018-07-23T02:58:32Z

Developer-guide/Backport-Guidelines.md

+* No feature from master would be backported to the release branch
+* Any CVE (aka, security alerts) on the existing releases would be backported, after getting fixed in master branch.
+* Only severe issues, crashes, data loss, or unavailability issues would be backported to the release.
+* For any other issues, upgrading to the higher version where bug is fixed is the recommended way.


For any other issues, the project recommends that the installation be upgraded to a newer release where the specific bug has been addressed.

sankarshanmukhopadhyay · 2018-07-23T02:59:22Z

Developer-guide/Backport-Guidelines.md

+  - Gluster provides 'rolling' upgrade support, i.e., one can upgrade their version without stopping the application I/O, so we recommend migrating to higher version.

-                git clone ssh://username@review.gluster.org/glusterfs
+## Things to take care while backporting a patch.


to pay attention to while backporting a patch.

amarts · 2018-07-26T07:00:35Z

Addressed all the comments by @sankarshanmukhopadhyay

@prashanthpai @nigelbabu can we merge this?

humblec · 2018-07-26T09:26:21Z

Developer-guide/Backport-Guidelines.md

-## via Git command-line
-1.  Git clone the GlusterFS code
+* No feature from master would be backported to the release branch
+* CVE ie., security vulnerability (listed on the CVE database) reported in


Do we need to mention CVE database link ?

A link like https://cve.mitre.org/cve/search_cve_list.html might be good to have.

humblec · 2018-07-26T09:27:12Z

Developer-guide/Backport-Guidelines.md

+backported to the release.
+* For any other issues, the project recommends that the installation be
+upgraded to a newer release where the specific bug has been addressed.
+  - Gluster provides 'rolling' upgrade support, i.e., one can upgrade their


rolling upgrade -> Is it applicable for both client and server?

No, not for client.

It is important to point out users that this document is pointing at 'GlusterFS', but there are more projects in gluster org. Signed-off-by: Amar Tumballi <amarts@redhat.com>

prashanthpai

Have suggested some very minor changes.

Another suggestion unrelated to your PR:

I was trying out building from source on fedora 28 (to check gcc8 errors) and found these 3 packages missing to be mentioned as dependency duing dnf install on Fedora:

rpcgen libtirpc-devel make

It'll be great if you can add these to Building-GlusterFS.md when you refresh the PR. It'll save me from sending a separate PR for it :)

prashanthpai · 2018-08-03T03:46:39Z

Developer-guide/Projects.md

-   Owner: Xavier Hernandez (Datalab)
+Repo: https://github.com/gluster/glusterd2
+
+New management layer for glusterfs. Has navitive ReST API, and uses etcd to


prashanthpai · 2018-08-03T03:48:32Z

Developer-guide/Development-Workflow.md

-1.  Build, create, and install the RPMS as described in
-    [CompilingRPMS](./Compiling-RPMS.md).
-2.  Configure UFO/SWIFT as described in [Howto Using UFO SWIFT - A quick
+1.  Configure UFO/SWIFT as described in [Howto Using UFO SWIFT - A quick


The link can be updated to this one: https://github.com/gluster/gluster-swift/blob/master/doc/markdown/quick_start_guide.md

Moved it to another place, and updated the Link

prashanthpai · 2018-08-03T03:49:39Z

Developer-guide/Backport-Guidelines.md

-Anyone in the community can suggest a backport. If you are interested to
-suggest a backport, please check the [Backport
-Wishlist](./Backport-Wishlist.md).
+This page describes the policy GlusterFS has regarding the backports. As a user, or contributor, being aware of this policy would help you to understand how to request for backport from community.


It's better to stick to 80 character limit wherever possible - here and elsewhere in the PR. The hyperlinks are an exception though. Markdown doesn't interpret single line break as a new line during rendering.

Clearly state what is backport, and why we do it. Remove 'Backport Wishlist' as it was out of date, and doesn't make anymore sense. Signed-off-by: Amar Tumballi <amarts@redhat.com>

* Remove Easy-Fix list of bugs from bugzilla. * Coverity document is revisited with minor changes Signed-off-by: Amar Tumballi <amarts@redhat.com>

Signed-off-by: Amar Tumballi <amarts@redhat.com>

Major reason for removing is, it is out-of-date. Second, we don't expect users to build RPMs, they can consume the nightly RPM builds from our CI systems. For every release, we do build and provide RPMs. For all other purposes, source install is sufficient. Signed-off-by: Amar Tumballi <amarts@redhat.com>

Update the document to point to the latest facts about the contributions, so one needn't get confused. Signed-off-by: Amar Tumballi <amarts@redhat.com>

prashanthpai requested review from humblec, joejulian and nbalacha July 23, 2018 02:36

amarts force-pushed the doc-hackathon-developer-doc branch from b1eb898 to 1f35d76 Compare July 23, 2018 02:44

sankarshanmukhopadhyay reviewed Jul 23, 2018

View reviewed changes

amarts force-pushed the doc-hackathon-developer-doc branch from 1f35d76 to 287d29e Compare July 23, 2018 05:31

amarts force-pushed the doc-hackathon-developer-doc branch from 287d29e to 4e3b7af Compare July 26, 2018 07:03

humblec reviewed Jul 26, 2018

View reviewed changes

developer-index: fix the flow

b8aa86b

It is important to point out users that this document is pointing at 'GlusterFS', but there are more projects in gluster org. Signed-off-by: Amar Tumballi <amarts@redhat.com>

amarts force-pushed the doc-hackathon-developer-doc branch from 4e3b7af to cf94ba3 Compare August 2, 2018 06:14

prashanthpai reviewed Aug 3, 2018

View reviewed changes

amarts added 5 commits August 3, 2018 13:56

Backport-Guidelines: fix the policy

efa2418

Clearly state what is backport, and why we do it. Remove 'Backport Wishlist' as it was out of date, and doesn't make anymore sense. Signed-off-by: Amar Tumballi <amarts@redhat.com>

Coverity: minor fixes

01b2a58

* Remove Easy-Fix list of bugs from bugzilla. * Coverity document is revisited with minor changes Signed-off-by: Amar Tumballi <amarts@redhat.com>

Projects: cleanup few things

9957139

Signed-off-by: Amar Tumballi <amarts@redhat.com>

Development Workflow: bring some sanity

936edb0

Update the document to point to the latest facts about the contributions, so one needn't get confused. Signed-off-by: Amar Tumballi <amarts@redhat.com>

amarts force-pushed the doc-hackathon-developer-doc branch from cf94ba3 to 936edb0 Compare August 3, 2018 08:32

prashanthpai approved these changes Aug 3, 2018

View reviewed changes

prashanthpai merged commit c4815dd into gluster:master Aug 3, 2018

Conversation

amarts commented Jul 21, 2018

Uh oh!

prashanthpai commented Jul 23, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

amarts commented Jul 26, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sankarshanmukhopadhyay Aug 2, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

prashanthpai left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

sankarshanmukhopadhyay Aug 2, 2018 •

edited

Loading