This repository has been archived by the owner. It is now read-only.

localized/customize project READEME.md (documentation) #16

Open
wants to merge 2 commits into
base: develop
from

Conversation

4 participants
@Fenn-CS
Copy link
Contributor

Fenn-CS commented Jun 14, 2018

Signed-off-by: Fenn-25 fenn25.fn@gmail.com

Description

Added a documentation that is specific for the systers clone of Hyperkitty.

However, the documentation needs to be updated after completion of issue #15 in order for the readme to reflect the right coverage and travis-ci reports. Wiki pages have to be created and the appropriate links pointed(updated) in the document also.

Fixes #14

Type of Change:

  • Documentation

How Has This Been Tested?

N/A (code not affected)

Checklist:

  • My PR follows the style guidelines of this project
  • I have performed a self-review of my own code or materials

@Fenn-CS Fenn-CS requested review from nida , prachi1210 and MehaKaushik Jun 14, 2018

@MehaKaushik

This comment has been minimized.

Copy link
Collaborator

MehaKaushik commented Jun 14, 2018

Hey @Fenn-CS where did you add the documentation(i.e. the content of Readme) from ? Is it imported from somewhere or you have written it afresh?

@Fenn-CS Fenn-CS force-pushed the Fenn-CS:localize-documentation-hyperkitty branch from b06faaf to f3aa197 Jun 14, 2018

@Fenn-CS

This comment has been minimized.

Copy link
Contributor

Fenn-CS commented Jun 14, 2018

@Fenn-CS Fenn-CS force-pushed the Fenn-CS:localize-documentation-hyperkitty branch from b609219 to eef57b0 Jun 17, 2018

@Fenn-CS Fenn-CS changed the title localized documentation localized/ customize project READEME.md (documentation) Jun 17, 2018

@Fenn-CS Fenn-CS changed the title localized/ customize project READEME.md (documentation) localized/customize project READEME.md (documentation) Jun 17, 2018

@Fenn-CS

This comment has been minimized.

Copy link
Contributor

Fenn-CS commented Jun 18, 2018

@nida
Copy link
Member

nida left a comment

Looks good

added systers specific readme
Signed-off-by: Fenn-25 <fenn25.fn@gmail.com>

@Fenn-CS Fenn-CS force-pushed the Fenn-CS:localize-documentation-hyperkitty branch from eef57b0 to 9efe645 Jun 18, 2018

@Fenn-CS

This comment has been minimized.

Copy link
Contributor

Fenn-CS commented Jun 18, 2018

@MehaKaushik I have addressed the issues you pointed out... Please review once more

*Please note, the [live documentation](http://hyperkitty.readthedocs.io/en/latest/development.html) contains many other details that are important but may not be required for a successful setup, you are strongly encouraged to visit the live documentation as well.*


If you face any issues while setting up Hyperkitty locally, have a look at issues labelled as [hyperkitty-setup](https://github.com/systers/portal/labels/hyperkitty-setup). We are on slack you can make use of the [#hyperkitty and #questions](https://systers-opensource.slack.com/messages/C0FGYV50U/) channels.

This comment has been minimized.

@MehaKaushik

MehaKaushik Jun 23, 2018

Collaborator

Please mention mailman3 channel here.

@MehaKaushik
Copy link
Collaborator

MehaKaushik left a comment

I have left one small comment, please address that. Apart from that the PR is good to go.

@MehaKaushik

This comment has been minimized.

Copy link
Collaborator

MehaKaushik commented Jul 8, 2018

@nida please have a look at this PR.

@Monal5031

This comment has been minimized.

Copy link
Member

Monal5031 commented Jul 13, 2018

@Fenn-CS https://github.com/Fenn-CS/hyperkitty/blob/9efe64510bf1c0a43b6e0fe89bd55b46155bc9b5/setup.py#L47 this mentions use of README.rst in long description but you have added a README.md that would cause the setup to fail?
Try refactoring once, if there are any other issues.

@Fenn-CS

This comment has been minimized.

Copy link
Contributor

Fenn-CS commented Jul 13, 2018

@Monal5031 Yeah! That can cause problems. I am fixing that now.

referenced correct readme in setup
Signed-off-by: Fenn-25 <fenn25.fn@gmail.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.