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

Gluster needs more developer specific documentation #225

Closed
nbalacha opened this issue Mar 25, 2017 · 5 comments
Closed

Gluster needs more developer specific documentation #225

nbalacha opened this issue Mar 25, 2017 · 5 comments

Comments

@nbalacha
Copy link

glusterdocs needs to be updated with more information on gluster internals for developers interested in working on the project.

@humblec
Copy link
Contributor

humblec commented Mar 25, 2017

@nbalacha totally agree. All the developers has to contribute to achieve this goal. May be we have to come up with a mandatory process to improve the developer documentation. Any thoughts or ideas for the same ?

@prashanthpai
Copy link
Contributor

@nbalacha @humblec All developer docs currently resides in the glusterfs repo and should continue to do so. This repo is only for admins and users of GlusterFS.

@nigelbabu
Copy link
Contributor

@prashanthpai Does that mean the contributor guide doesn't have a place?

@prashanthpai
Copy link
Contributor

@nigelbabu Not all contributors are developers. Contributions can come in many ways - documentation, bug reports, website maintenance etc. The contributors guide currently resides in this repo, which is the right place.

Developers who intend to review/send code patches to GlusterFS code repo (or hack privately) will be looking for documentation on internals (data structures, implementation details) of GlusterFS. This should reside in glusterfs repo as it is done today.

@humblec
Copy link
Contributor

humblec commented Mar 27, 2017

@prashanthpai @nbalacha yes, its in different source. However I thought @nbalacha's request here is to improve the same.

@humblec humblec reopened this Mar 27, 2017
@humblec humblec closed this as completed Apr 1, 2017
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

No branches or pull requests

4 participants