Bug 550936 - Improve documentation
Summary: Improve documentation
Status: UNCONFIRMED
Alias: None
Product: RCPTT
Classification: Technology
Component: Infrastructure (show other bugs)
Version: unspecified   Edit
Hardware: All All
: P3 normal (vote)
Target Milestone: ---   Edit
Assignee: Project Inbox CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2019-09-10 09:35 EDT by Steven MacDiarmid CLA
Modified: 2019-09-23 06:13 EDT (History)
1 user (show)

See Also:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Steven MacDiarmid CLA 2019-09-10 09:35:40 EDT 
I'm just getting started using RCPTT and am finding the documentation hard to read. The information is accurate but there are many grammatical and stylistic errors. I am guessing it was mainly written by people who speak English as a second language. I am an experienced editor and would be happy to help improve the docs as I work through them.
Comment 1 Vasili Gulevich CLA 2019-09-23 06:08:15 EDT 
(In reply to Steven MacDiarmid from comment #0)
> I'm just getting started using RCPTT and am finding the documentation hard
> to read. The information is accurate but there are many grammatical and
> stylistic errors. I am guessing it was mainly written by people who speak
> English as a second language. I am an experienced editor and would be happy
> to help improve the docs as I work through them.

Feel free to contribute your Gerrit changes.

Gerrit repository for documentation is https://git.eclipse.org/r/#/admin/projects/www.eclipse.org/rcptt

To modify:

    git clone ssh://git.eclipse.org/gitroot/www.eclipse.org/rcptt.git
    git checkout sculpin
    do changes
    git commit
    git push

To test:
    sculpin generate --env=prod #requires sculpin (https://sculpin.io/)
Comment 2 Vasili Gulevich CLA 2019-09-23 06:13:27 EDT 
Actually, Gerrit will require another fetch URL.

git clone ssh://freudstein@git.eclipse.org:29418/www.eclipse.org/rcptt

(Replace freudstein with your actual Gerrit id)