Re: [PATCH] Replace contribution list in CONTRIBUTE file with wiki link

[Alan Hayward <Alan dot Hayward at arm dot com>]

> On 24 Jan 2019, at 13:00, Pedro Alves <palves@redhat.com> wrote:
> 
> On 01/23/2019 05:15 PM, Alan Hayward wrote:
>> Combing both threads. New version below
>> 
>>> On 23 Jan 2019, at 16:03, Pedro Alves <palves@redhat.com> wrote:
>>> 
>>> On 01/23/2019 09:46 AM, Alan Hayward wrote:
>>> 
>>>> +https://sourceware.org/gdb/wiki/ContributionChecklist
>>> 
>>> I'd rather point at https://sourceware.org/gdb/contribute/
>>> and then have _that_ point at some page in the wiki.
>>> That's what I had suggested in the other thread.
>>> The reason is that the <https://sourceware.org/gdb/contribute/>
>>> URL is going to be more stable than a wiki link, which we can
>>> rename, split, etc. a bit more freely.  The contribution checklist page
>>> is quite large by now, and I've heard of people wishing for a smaller more
>>> concise entry point.  The checklist was meant to be that, a checklist.
>>> A "how to contribute" page may have some higher level info to
>>> get people started.
> 
>> Fair enough. Having the double link seemed redundant, but your
>> reasoning makes sense.
>> 
>> The sourceware contribute page itself needs an update (it currently
>> points to the CONTRIBUTE file!) How do we go about making that change?
>> 
> 
> That has been the (mental) blocker for me thus far.  The webpages are
> still in CVS somewhere.  I never touched it myself.  
> Joel, can you guide us here?
> 
> AFAIK the current process is that commits go to both sourceware.org's CVS and
> to another copy in gnu.org as well for the https://www.gnu.org/software/gdb/ .
> I had chatted with Joel at the Cauldron about streamlining this, and the
> conclusion seemed to be that there's no real blocker for making the gnu.org
> version simply a redirect to sourceware.org.  That would simplify things.  The
> other neat step would be to migrate to git.  :-)  
> 
> 
>> Wanted to avoid rewriting as much as possible. But now I’m wondering if it
>> maybe needs reducing down a little more.
>> 
>> How about the following (can repost with proper diff, but easier to read
>> if I just paste it)
> 
> Yeah.  
> 
> It'd to be good to make sure to migrate any useful info being
> deleted, if not covered in the web site already, rather than just
> losing it, IMHO, though.  I think most of the steps in the file
> are covered by the checklist wiki, but the larger/expanded intro
> text currently in gdb/CONTRIBUTE would be useful on
> the https://sourceware.org/gdb/contribute/ landing page, I believe.
> 
>> 
>> 
>> 
>> 			Contributing to GDB
>> 
>> GDB is a collaborative project that relies on contributions.  You can
>> help in this!  You may wish to fix bugs, improve testing, port GDB to
>> a new platform, update documentation, add new features or optimizations,
>> contribute to the mailing lists or offical GDB website, etc.  We welcome
> 
> typo in "offical".
> 
>> all of the above and feel free to ask on the GDB mailing lists if you are
> 
>> looking for feedback or for people to review a work in progress. For
>> more information see:
>> 
>> https://sourceware.org/gdb/
>> 
>> 
>> In order for any code patches to be considered for submission, please
>> also see the contribution guide:
> 
> I'm not very keen on this sentence since there's more to contribution that
> code patches: bug triaging, testing, helping users on the gdb mailing
> list, etc.
> 
>> 
>> https://sourceware.org/gdb/contribute/
>> 
>> 
> 
> Since this whole file is all about contributing, I think we can replace
> both URLs with a single URL pointing at the contribution page, and
> drop the "in order for any ..." sentence altogether.  I.e., just say:
> 
> ~~~
> ... looking for feedback or for people to review a work in progress. For
> more information see:
> 
> https://sourceware.org/gdb/contribute/
> ~~~
> 
> Once there, it should be trivial and obvious for a user to reach the homepage.
> 
> Thanks,
> Pedro Alves

With those changes, we now have: 

			Contributing to GDB

GDB is a collaborative project that relies on contributions.  You can
help in this!  You may wish to fix bugs, improve testing, port GDB to
a new platform, update documentation, add new features or optimizations,
contribute to the mailing lists or official GDB website, etc.  We welcome
all of the above and feel free to ask on the GDB mailing lists if you are
looking for feedback or for people to review a work in progress.  For
more information see:

https://sourceware.org/gdb/contribute/




For the webpage, how about the following. Everything in a [] is a link which
needs replacing with the relevant link from the list at the end (and the list
itself deleted).



			Contributing to GDB

GDB is a collaborative project that relies on contributions.  You can help in this!  You may wish to fix bugs, improve testing, port GDB to a new platform, update documentation, add new features or optimizations, contribute to the mailing lists or official GDB website, etc.  We welcome all of the above and feel free to ask on the [GDB Mailing Lists] if you are looking for feedback or for people to review a work in progress.

To help with this, there is plenty of documentation available.  In addition to the [User Guide] and [Internals Manual] included in the GDB distribution, the [GDB Wiki] also contain substantial information.  If you are looking for a project then check the [Project Ideas] page.

If you write a change to the GDB codebase we encourage you to distribute the change yourself.  You may also want to submit your change so that can be considered for inclusion in a future version of GDB.  If so then there are certain legal requirements and style issues which all contributors need to be aware of - for more details please read the [Contribution Checklist].


[GDB Mailing Lists] https://sourceware.org/gdb/mailing-lists/
[User Guide] https://sourceware.org/gdb/current/onlinedocs/gdb/
[Internals Manual] https://sourceware.org/gdb/wiki/Internals
[GDB Wiki] https://sourceware.org/gdb/wiki/
[Project Ideas] https://sourceware.org/gdb/wiki/ProjectIdeas
[Contribution Checklist] https://sourceware.org/gdb/wiki/ContributionChecklist


Alan.