Thread: Adding to Documentation

Adding to Documentation

From
Lev Lazinskiy
Date:
Hi Team!

My name is Lev. I am a long time PostgreSQL user but just switched to
pgadminIII when I switched to Ubuntu full time from OS X. My background
is in testing, general GNU/Linux sys admin, databases, and python. I know some C and C++ and would
love to contribute more to this project.

I was having some issues getting SSH tunneling to work and the solution
was simply that I was not entering my passphrase for my encrypted key.
I searched the web for this issue and there seems to be a bit of
confusion around this with no great solution. Most users give up and
revert to setting up an SSH tunnel locally and connecting to that.

I wanted to add this to the application documentation under
http://www.pgadmin.org/docs/1.22/connect-error.html, but I did not see
any specific instructions or best practices on how to do that. Do I just
hack away at the docs/connect-error.rst file and send a patch here?

Lastly, I am using pgAdmin III 1.20.0 Beta 2, but this documentation
would really apply for any version that supports SSH tunneling.
Is there a standard practice for "backporting" docs or do we just keep
moving along.

Looking forward to hearing from you soon!

Best,
Lev


Re: Adding to Documentation

From
Dave Page
Date:
Hi

On Tue, Mar 15, 2016 at 7:36 AM, Lev Lazinskiy <lev@levlaz.org> wrote:
> Hi Team!
>
> My name is Lev. I am a long time PostgreSQL user but just switched to
> pgadminIII when I switched to Ubuntu full time from OS X. My background
> is in testing, general GNU/Linux sys admin, databases, and python. I know some C and C++ and would
> love to contribute more to this project.
>
> I was having some issues getting SSH tunneling to work and the solution
> was simply that I was not entering my passphrase for my encrypted key.
> I searched the web for this issue and there seems to be a bit of
> confusion around this with no great solution. Most users give up and
> revert to setting up an SSH tunnel locally and connecting to that.
>
> I wanted to add this to the application documentation under
> http://www.pgadmin.org/docs/1.22/connect-error.html, but I did not see
> any specific instructions or best practices on how to do that. Do I just
> hack away at the docs/connect-error.rst file and send a patch here?

Yes please. Please create patches from either git master or the
REL-1_22_0-PATCHES branch, using "git diff".

> Lastly, I am using pgAdmin III 1.20.0 Beta 2, but this documentation
> would really apply for any version that supports SSH tunneling.
> Is there a standard practice for "backporting" docs or do we just keep
> moving along.

We'll backport to 1.22 (or forward port from there to master), but
won't go further back than that as we'll never release another earlier
branch again.

Thanks!

--
Dave Page
Blog: http://pgsnake.blogspot.com
Twitter: @pgsnake

EnterpriseDB UK: http://www.enterprisedb.com
The Enterprise PostgreSQL Company