[Feedhenry-raincatcher] Raincatcher Docs

Wojciech Trocki wtrocki at redhat.com
Fri Oct 20 11:31:30 UTC 2017


Thank you for contributing to RainCatcher project.
I have accepted and merged all your PR's.
Really good job!

PS You are really close to get t-shirt from hacktoberfest :)
https://hacktoberfestchecker.herokuapp.com/?username=oraNod

On Wed, Oct 18, 2017 at 4:42 PM, Wojciech Trocki <wtrocki at redhat.com> wrote:

> I forgot to mention. If you need assistance or are unsure about anything
> give me shout on our community channel.
> Really happy to help.
>
> On Wed, Oct 18, 2017 at 4:04 PM, Wojciech Trocki <wtrocki at redhat.com>
> wrote:
>
>> Hi Don
>>
>> > My name is Don Naro. I've recently forked the raincatcher-docs repo and
>> would like to contribute to the content.
>>
>> Welcome to RainCatcher community. We really appreciate any help on
>> improving our documentation,.
>> Our contributing guidelines are targeted mostly to developers, but still
>> worth reading:
>> https://github.com/feedhenry-raincatcher/raincatcher-core/bl
>> ob/master/CONTRIBUTING.md
>>
>> Let's start small first and try with the current PR - we can easily split
>> all changes in this PR to 4 different problems.
>> This will help us to review that and it will reduce number of review
>> bounces.
>> That's not effective for all of us.
>>
>> In relation to your proposition I think it's best to have separate
>> discussion/email thread/jira for each to be more effective.
>> Personally I do not care about any style changes as long we are
>> consistent.
>> Changing only single while 99% of the others still have old one it's the
>> worst thing we can do.
>>
>> > I'm sure I speak for all when I say to start small, incremental
>> changes are easier to create and manage.
>>
>> Fully agree!
>>
>> I think the rule is less about size, but about type of the changes.
>> If you fixing problem with documentation (considered a bug) then you can
>> just create PR and fix that.
>> When adding something that's new then we will need to have discussion
>> with the team and decide where to go.
>> It will be nice to create jira ticket and maintain follow up conversation
>> there.
>>
>> How to know that something is new? Every style change or rephrasing
>> sentences may affect actual technical meaning so we need to be careful.
>> What is also important to make sure that your PR contains only changes
>> that are needed and you do not remove things that were essential.
>> Even smallest PR with single typo fix may be huge help and reviews will
>> be really fast.
>> You do not need to rewrite our docs to help - start with small things
>> first.
>> Be as clearly as possible for your intentions.
>>
>> I will also recommend to register to hacktoberfest(you will get t-shirt
>> for 4 PR's)
>> https://hacktoberfest.digitalocean.com/
>>
>> TL;DR - I think if you will try to apply "small changes" pattern for your
>> PR and split that to 2-3 PR's with typos etc.
>> You can close original one if needed.
>> There is nothing wrong with PR containing fix for once sentence.
>>
>> Regards
>>
>>
>>
>> On Wed, Oct 18, 2017 at 3:09 PM, Don Naro <don.naro.jr at gmail.com> wrote:
>>
>>> Hi all,
>>>
>>> My name is Don Naro. I've recently forked the raincatcher-docs repo and
>>> would like to contribute to the content.
>>>
>>> In my opinion, the content could be made much more concise. I'd like to
>>> simplify and streamline some of the procedures. I also see some redundant
>>> information that we could remove.
>>>
>>> One of the other things I've noticed is that a lot of headings aren't
>>> quite so meaningful. As a user, I can't accurately derive the meaning of
>>> the content that follows a lot of the headings.
>>>
>>> I'd love to work on these docs some more. What's the best way to
>>> approach this?
>>>
>>> Should I start with a PR to suggest structural changes and then create
>>> additional PRs to rework the content? Would it be better if I just did
>>> everything in a single PR?
>>>
>>> Please let me know what you think would be best. I'm happy to contribute
>>> in any way.
>>>
>>> By the way, I wanted to confirm that I have been able to get the server,
>>> portal, and mobile apps running locally. I've also been able to build the
>>> website locally and build the asciidocs to review changes. It's really cool
>>> tech. I've enjoyed learning about it so far.
>>>
>>> Cheers,
>>> Don
>>>
>>> _______________________________________________
>>> Feedhenry-raincatcher mailing list
>>> Feedhenry-raincatcher at redhat.com
>>> https://www.redhat.com/mailman/listinfo/feedhenry-raincatcher
>>>
>>>
>>
>>
>> --
>>
>> WOJCIECH TROCKI
>>
>> Red Hat Mobile <https://www.redhat.com/>
>>
>> IM: wtrocki
>> <https://red.ht/sig>
>>
>
>
>
> --
>
> WOJCIECH TROCKI
>
> Red Hat Mobile <https://www.redhat.com/>
>
> IM: wtrocki
> <https://red.ht/sig>
>



-- 

WOJCIECH TROCKI

Red Hat Mobile <https://www.redhat.com/>

IM: wtrocki
<https://red.ht/sig>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://listman.redhat.com/archives/feedhenry-raincatcher/attachments/20171020/207ab14b/attachment.htm>


More information about the Feedhenry-raincatcher mailing list