Skip to content
This repository has been archived by the owner on Mar 26, 2020. It is now read-only.

doc: detailed changes for user doc #1063

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

harigowtham
Copy link
Member

Has the first set of changes to improve a doc with differentiation
for user.

managing volumes, feature, known issues and trouble shooting are yet to be worked on.

updates:#891
Signed-off-by: Hari Gowtham [email protected]

@prashanthpai
Copy link
Contributor

prashanthpai commented Jul 25, 2018

Has the first set of changes to improve a doc with differentiation
for user.

I'm worried. This is a lot of documentation. The goal here is not to port everything from docs.gluster.org to this repo.

@harigowtham
Copy link
Member Author

Yes. I understand. The requirements i got was to make it detailed in a way that its easier for someone who doesn't have experience with gluster to find it useful. If thats not the case targeted here I can remove the parts which we feel aren't necessary.

My take is to remove the docs related to glusterfs and just mention about glusterd2 even if it makes the user go back to glusterfs and learn about it.

@harigowtham harigowtham force-pushed the user_doc branch 2 times, most recently from 4d239f9 to 4079718 Compare August 17, 2018 10:27
Has the first set of changes to improve a doc with differentiation
for user.

managing volumes, feature, known issues and trouble shooting are yet to be worked on.

Signed-off-by: Hari Gowtham <[email protected]>
Copy link
Member Author

@harigowtham harigowtham left a comment

Choose a reason for hiding this comment

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

@rishubhjain @prashanthpai @aravindavk do take a look and let me know your comments.


### Basics Tasks

[Starting and stopping GD2](doc/managing-the-glusterd2-service.md)
Copy link
Member Author

Choose a reason for hiding this comment

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

This needs spacing. will update it while addressing others comments.


### Features

[Geo-replication](doc/geo-replication.md)
Copy link
Member Author

Choose a reason for hiding this comment

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

This needs proper spacing as well. will do it with next update.

@harigowtham
Copy link
Member Author

@pratikvmulay do take a look when you find time.

<a name="adding-servers"></a>
### Adding Servers

To add a server to a TSP, do add peer from a server already in the pool.
Copy link
Contributor

Choose a reason for hiding this comment

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

"do add peer" -> "do peer add"

<a name="listing-servers"></a>
### Listing Servers

To list all nodes in the TSP:
Copy link
Contributor

Choose a reason for hiding this comment

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

nodes -> servers

+--------------------------------------+---------+-----------------------+-----------------------+


Verify the peer status from the first server (server1):
Copy link
Contributor

Choose a reason for hiding this comment

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

You can provide a link to peer status section instead of mentioning it again.


## Glusterd2 and glusterfs

This helps in understanding how glusterd2 (GD2) goes along with glusterfs.
Copy link
Contributor

Choose a reason for hiding this comment

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

This section or this document?

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants