Discussion:
[FE-discuss] Docs
Ian Wilson
2011-08-25 20:20:30 UTC
Permalink
Hello magical new maintainer people,

What is the story with the docs on formencode.org? Are these the current
docs? How can we get the validator docs working? Can I help with that ? I
go to look at them and you really have to dig around to get to them and then
they are just plain text.

Specifically this:

http://formencode.org/Validator.html#available-validators

Used to be linked to something like this:

http://formencode.org/module-formencode.validators-index.html

It would nice to just re-roll all this to work with sphinx but really I'd be
cool with just having that link work.

Thanks.
David Stanek
2011-08-25 20:30:08 UTC
Permalink
Post by Ian Wilson
Hello magical new maintainer people,
What is the story with the docs on formencode.org? Are these the current
docs? How can we get the validator docs working? Can I help with that ? I
go to look at them and you really have to dig around to get to them and then
they are just plain text.
http://formencode.org/Validator.html#available-validators
http://formencode.org/module-formencode.validators-index.html
Unless someone knows off the top of their head I can take a look tonight. At
a quick glance it looks like either the section is missing or the fragment
is incorrect.
Post by Ian Wilson
It would nice to just re-roll all this to work with sphinx but really I'd
be cool with just having that link work.
To my knowledge they are actually built with sphinx. Are you suggesting that
we use it in a different way?


--
David
blog: http://www.traceback.org
twitter: http://twitter.com/dstanek
www: http://dstanek.com
Christoph Zwerschke
2011-08-27 14:27:57 UTC
Permalink
Ian's patch looks good to me, can somebody pull it and update the Sphinx
docs on the server?

Even better, can somebody move the push access rights from
ian/formencode to the new formencode/official repository, so people like
me can continue to help with maintenance and don't accidentally push to
the wrong repository? There are already 2 changesets which need to be
applied to the official one, and there are 2 older pull requests which
should be reviewed.

-- Christoph
David Stanek
2011-08-27 16:25:09 UTC
Permalink
Post by Christoph Zwerschke
Even better, can somebody move the push access rights from
ian/formencode to the new formencode/official repository, so people like
me can continue to help with maintenance and don't accidentally push to
the wrong repository? There are already 2 changesets which need to be
applied to the official one, and there are 2 older pull requests which
should be reviewed.
Where can I find out what users have push access?
--
David
blog: http://www.traceback.org
twitter: http://twitter.com/dstanek
www: http://dstanek.com
Christoph Zwerschke
2011-08-27 19:02:00 UTC
Permalink
Post by David Stanek
Where can I find out what users have push access?
When you're owner or admin of the repo,
Bitbucket should show a tab "Admin".

-- Christoph
Chris Lambacher
2011-08-27 21:04:37 UTC
Permalink
Hi,

Speaking of access, David and I still don't have access to the
sourceforge bug tracker. I was at one point going to start going
through all the still open bugs and see what we needed to do to be
able to close them.

I think we had high level plans to move the bugs to bitbucket.org but
we can't do that until we see what is still valid in the old tracker.

-Chris
Post by Christoph Zwerschke
Post by David Stanek
Where can I find out what users have push access?
When you're owner or admin of the repo,
Bitbucket should show a tab "Admin".
-- Christoph
------------------------------------------------------------------------------
EMC VNX: the world's simplest storage, starting under $10K
The only unified storage solution that offers unified management
Up to 160% more powerful than alternatives and 25% more efficient.
Guaranteed. http://p.sf.net/sfu/emc-vnx-dev2dev
_______________________________________________
FormEncode-discuss mailing list
https://lists.sourceforge.net/lists/listinfo/formencode-discuss
--
Christopher Lambacher
***@kateandchris.net
Christoph Zwerschke
2011-08-28 09:48:12 UTC
Permalink
Post by Chris Lambacher
Speaking of access, David and I still don't have access to the
sourceforge bug tracker. I was at one point going to start going
through all the still open bugs and see what we needed to do to be
able to close them.
I think we had high level plans to move the bugs to bitbucket.org but
we can't do that until we see what is still valid in the old tracker.
Right, there are 38 bugs, 6 feature requests and 2 patches open on SF.
Maybe let's have an IRC sprint for working on these?

And also speaking of access, who has access to formencode.org and can
rebuild the sphinx docs there when something has changed?

-- Christoph
Chris Lambacher
2011-08-28 15:24:13 UTC
Permalink
Right, there are 38 bugs, 6 feature requests and 2 patches open on SF. Maybe
let's have an IRC sprint for working on these?
Some of the open bugs are dups or already fixed. But I have not been
able to close them because I don't have access.

Either Ian or Philip Jenvey can admin the Sourceforge site.
And also speaking of access, who has access to formencode.org and can
rebuild the sphinx docs there when something has changed?
I have no idea who has access to that. I think we'll need some
intervention from Ian on that one.

-Chris
--
Christopher Lambacher
***@kateandchris.net
David Stanek
2011-08-28 15:27:44 UTC
Permalink
Post by Chris Lambacher
Post by Christoph Zwerschke
Right, there are 38 bugs, 6 feature requests and 2 patches open on SF.
Maybe
Post by Christoph Zwerschke
let's have an IRC sprint for working on these?
Some of the open bugs are dups or already fixed. But I have not been
able to close them because I don't have access.
Either Ian or Philip Jenvey can admin the Sourceforge site.
Post by Christoph Zwerschke
And also speaking of access, who has access to formencode.org and can
rebuild the sphinx docs there when something has changed?
I have no idea who has access to that. I think we'll need some
intervention from Ian on that one.
Ian mentioned giving me SSH access to the host so I'll pursue that offline.
Once I can get in there I'll have the docs updated.
--
David
blog: http://www.traceback.org
twitter: http://twitter.com/dstanek
www: http://dstanek.com
David Stanek
2011-08-28 15:29:03 UTC
Permalink
Post by Christoph Zwerschke
Post by Chris Lambacher
Speaking of access, David and I still don't have access to the
sourceforge bug tracker. I was at one point going to start going
through all the still open bugs and see what we needed to do to be
able to close them.
I think we had high level plans to move the bugs to bitbucket.org but
we can't do that until we see what is still valid in the old tracker.
Right, there are 38 bugs, 6 feature requests and 2 patches open on SF.
Maybe let's have an IRC sprint for working on these?
I think that this is a great idea. Maybe a weekend sprint?
--
David
blog: http://www.traceback.org
twitter: http://twitter.com/dstanek
www: http://dstanek.com
Christoph Zwerschke
2011-08-28 19:13:12 UTC
Permalink
Post by David Stanek
I think that this is a great idea. Maybe a weekend sprint?
That would be great. The next 2 weekends I'm already booked out, though.

-- Christoph
Ian Bicking
2011-08-29 18:39:31 UTC
Permalink
(a) Let's move to readthedocs.org.
(b) I've given Christoph admin permission on FormEncode (he had normal
permission before?) and David Stanek admin. Wasn't able to guess Chris
Lambacher's username ;)
Ian Wilson
2011-08-29 20:05:10 UTC
Permalink
I would also want to participate in some sort of sprint.

Also with regards to documentation, I think pypi can host docs too.
http://packages.python.org/an_example_pypi_project/buildanduploadsphinx.html

Is readthedocs.org meant to supplement existing documentation hosting or to
be the end all of documentation hosting ? I haven't really heard of it and
when I search for pyramid I get a 500 error.
Post by Ian Bicking
(a) Let's move to readthedocs.org.
(b) I've given Christoph admin permission on FormEncode (he had normal
permission before?) and David Stanek admin. Wasn't able to guess Chris
Lambacher's username ;)
------------------------------------------------------------------------------
Special Offer -- Download ArcSight Logger for FREE!
Finally, a world-class log management solution at an even better
price-free! And you'll get a free "Love Thy Logs" t-shirt when you
download Logger. Secure your free ArcSight Logger TODAY!
http://p.sf.net/sfu/arcsisghtdev2dev
_______________________________________________
FormEncode-discuss mailing list
https://lists.sourceforge.net/lists/listinfo/formencode-discuss
Ian Bicking
2011-08-29 20:20:08 UTC
Permalink
Weird about Pyramid, I filed a bug:
https://github.com/rtfd/readthedocs.org/issues/98

It would host all the docs. Examples that use it are
http://www.pip-installer.org/en/latest/index.html or
http://webtest.pythonpaste.org/en/latest/index.html – it handles generating
and updating docs automatically.
Post by Ian Wilson
I would also want to participate in some sort of sprint.
Also with regards to documentation, I think pypi can host docs too.
http://packages.python.org/an_example_pypi_project/buildanduploadsphinx.html
Is readthedocs.org meant to supplement existing documentation hosting or
to be the end all of documentation hosting ? I haven't really heard of it
and when I search for pyramid I get a 500 error.
Post by Ian Bicking
(a) Let's move to readthedocs.org.
(b) I've given Christoph admin permission on FormEncode (he had normal
permission before?) and David Stanek admin. Wasn't able to guess Chris
Lambacher's username ;)
------------------------------------------------------------------------------
Special Offer -- Download ArcSight Logger for FREE!
Finally, a world-class log management solution at an even better
price-free! And you'll get a free "Love Thy Logs" t-shirt when you
download Logger. Secure your free ArcSight Logger TODAY!
http://p.sf.net/sfu/arcsisghtdev2dev
_______________________________________________
FormEncode-discuss mailing list
https://lists.sourceforge.net/lists/listinfo/formencode-discuss
------------------------------------------------------------------------------
Special Offer -- Download ArcSight Logger for FREE!
Finally, a world-class log management solution at an even better
price-free! And you'll get a free "Love Thy Logs" t-shirt when you
download Logger. Secure your free ArcSight Logger TODAY!
http://p.sf.net/sfu/arcsisghtdev2dev
_______________________________________________
FormEncode-discuss mailing list
https://lists.sourceforge.net/lists/listinfo/formencode-discuss
Christoph Zwerschke
2011-08-29 22:28:30 UTC
Permalink
Post by Ian Wilson
I would also want to participate in some sort of sprint.
Also with regards to documentation, I think pypi can host docs too.
Yes, that would be an alternative. RTD seems to be more comfortable,
though since it builds directly from repos, you don't need to upload a
zip file. Are there any other pros/cons of PyPI vs. RTD? Maybe upload on
both in case one site is down, but then they can get out of sync and
people will always wonder which is the authorative doc version.

-- Christoph
Christoph Zwerschke
2011-08-29 22:19:36 UTC
Permalink
(a) Let's move to readthedocs.org <http://readthedocs.org>.
Just tried to build the docs with my user account, works nicely.
RTD even created a generic URL without my user name:

http://formencode.readthedocs.org

We could redirect formencode.org to that address now.

But how can now anybody else beside me edit the RTD settings for
formencode (Repo address etc.) or trigger a manual built? Is the above
URL now forever linked to the project in my user account? It would be
better to have the docs created from a generic user account where two or
more people have access.
https://github.com/rtfd/readthedocs.org/issues/98
Strange, it works for me. Has it already been fixed?
It would host all the docs. Examples that use it are
http://www.pip-installer.org/en/latest/index.html or
http://webtest.pythonpaste.org/en/latest/index.html – it handles
generating and updating docs automatically.
Does the auto update also work with bitbucket? I saw only gitbub
mentioned there.

-- Christoph
Christoph Zwerschke
2011-08-29 22:35:44 UTC
Permalink
Post by Ian Bicking
(b) I've given Christoph admin permission on FormEncode (he had normal
permission before?) and David Stanek admin. Wasn't able to guess Chris
Lambacher's username ;)
I still have only normal developer access, but that's sufficient for
closing tickets. Chris is lambacck.

You also should give us access to PyPI if you haven't. The PyPI page
still mentions the SVN repo instead of Mercurial.

-- Christoph
Ian Bicking
2011-08-29 22:49:32 UTC
Permalink
I must have forgotten to hit submit when changing your permissions. You and
Chris have admin over there, and everyone has PyPI access now.

There's a #readthedocs IRC channel that might be a good way to figure out
bitbucket integration (unless y'all want to move to github, which would also
be totally okay). Maybe it's possible to trigger a rebuild with the POST
notification bitbucket can put out? I can also CNAME formencode.org to
readthedocs.org and it's supposed to pick it up... but I haven't actually
done it myself, someone else has always set it up, I just go in and setup
the CNAME afterwards, so I'm not sure what has to be configured for that.
Post by Christoph Zwerschke
Post by Ian Bicking
(b) I've given Christoph admin permission on FormEncode (he had normal
permission before?) and David Stanek admin. Wasn't able to guess Chris
Lambacher's username ;)
I still have only normal developer access, but that's sufficient for
closing tickets. Chris is lambacck.
You also should give us access to PyPI if you haven't. The PyPI page still
mentions the SVN repo instead of Mercurial.
-- Christoph
Christoph Zwerschke
2011-08-30 22:41:06 UTC
Permalink
(a) Let's move to readthedocs.org <http://readthedocs.org>.
Completed now (the autodoc issue has been solved):

http://formencode.readthedocs.org

You can change the CNAME entry for formencode.org to the above domain.

-- Christoph
Ian Bicking
2011-08-30 22:51:44 UTC
Permalink
www.formencode.org is CNAME to formencode.readthedocs.org; I couldn't CNAME
formencode.org itself, so I just assigned it the same IP, but that might not
be as stable.
Post by Christoph Zwerschke
(a) Let's move to readthedocs.org <http://readthedocs.org>.
http://formencode.readthedocs.org
You can change the CNAME entry for formencode.org to the above domain.
-- Christoph
------------------------------------------------------------------------------
Special Offer -- Download ArcSight Logger for FREE!
Finally, a world-class log management solution at an even better
price-free! And you'll get a free "Love Thy Logs" t-shirt when you
download Logger. Secure your free ArcSight Logger TODAY!
http://p.sf.net/sfu/arcsisghtdev2dev
_______________________________________________
FormEncode-discuss mailing list
https://lists.sourceforge.net/lists/listinfo/formencode-discuss
Christoph Zwerschke
2011-08-31 10:08:33 UTC
Permalink
www.formencode.org <http://www.formencode.org> is CNAME to
formencode.readthedocs.org <http://formencode.readthedocs.org>; I
couldn't CNAME formencode.org <http://formencode.org> itself, so I just
assigned it the same IP, but that might not be as stable.
formencode.org does not work for me, I get a 404 error.
Maybe DNAME instead of CNAME will do?

-- Christoph
Chris Lambacher
2011-08-31 14:51:31 UTC
Permalink
Hi,

For formencode.org we should either have an A record pointing at the
readthedocs.org IP or we should redirect to www.formencode.org on some
cheap commodity hosting (I already have hosting that can manage as
many domains as I like so I can just add to that if we need to).

-Chris
Post by Christoph Zwerschke
www.formencode.org <http://www.formencode.org> is CNAME to
formencode.readthedocs.org <http://formencode.readthedocs.org>; I
couldn't CNAME formencode.org <http://formencode.org> itself, so I just
assigned it the same IP, but that might not be as stable.
formencode.org does not work for me, I get a 404 error.
Maybe DNAME instead of CNAME will do?
-- Christoph
------------------------------------------------------------------------------
Special Offer -- Download ArcSight Logger for FREE!
Finally, a world-class log management solution at an even better
price-free! And you'll get a free "Love Thy Logs" t-shirt when you
download Logger. Secure your free ArcSight Logger TODAY!
http://p.sf.net/sfu/arcsisghtdev2dev
_______________________________________________
FormEncode-discuss mailing list
https://lists.sourceforge.net/lists/listinfo/formencode-discuss
--
Christopher Lambacher
***@kateandchris.net
Ian Bicking
2011-08-31 16:31:43 UTC
Permalink
DNAME? What's that?

The IP address is set correctly in the registrar/DNS, but at least my
personal DNS still seems to be pointing to the old server.
www.formencode.org seems to work fine... editing /etc/hosts gets me the
404. Probably this is some configuration on readthedocs.org to map domain
names to projects?
Post by Christoph Zwerschke
www.formencode.org <http://www.formencode.org> is CNAME to
formencode.readthedocs.org <http://formencode.readthedocs.org>; I
couldn't CNAME formencode.org <http://formencode.org> itself, so I just
assigned it the same IP, but that might not be as stable.
formencode.org does not work for me, I get a 404 error.
Maybe DNAME instead of CNAME will do?
-- Christoph
------------------------------------------------------------------------------
Special Offer -- Download ArcSight Logger for FREE!
Finally, a world-class log management solution at an even better
price-free! And you'll get a free "Love Thy Logs" t-shirt when you
download Logger. Secure your free ArcSight Logger TODAY!
http://p.sf.net/sfu/arcsisghtdev2dev
_______________________________________________
FormEncode-discuss mailing list
https://lists.sourceforge.net/lists/listinfo/formencode-discuss
Christoph Zwerschke
2011-08-31 17:44:15 UTC
Permalink
Post by Ian Bicking
DNAME? What's that?
http://en.wikipedia.org/wiki/CNAME_record#DNAME_record
Ian Bicking
2011-08-31 17:47:20 UTC
Permalink
Hmm, I don't think my DNS provider supports that, but I suspect that is not
the issue in this case, as the request gets to readthedocs.org, it's the
server that's giving the 404.
Post by Christoph Zwerschke
Post by Ian Bicking
DNAME? What's that?
http://en.wikipedia.org/wiki/CNAME_record#DNAME_record
Christoph Zwerschke
2011-08-31 18:01:19 UTC
Permalink
Post by Ian Bicking
Hmm, I don't think my DNS provider supports that, but I suspect that is
not the issue in this case, as the request gets to readthedocs.org
<http://readthedocs.org>, it's the server that's giving the 404.
The webserver at readthedocs.org needs the canonical name
(formencode.readthedocs.org) for resolving the project. This works only
with a CNAME entry or probably with DNAME as well.

-- Christoph
Ian Bicking
2011-08-31 18:28:15 UTC
Permalink
Funny... I'm not sure if there's a good solution, so I just set up
formencode.org to redirect to www.formencode.org
Post by Christoph Zwerschke
Post by Ian Bicking
Hmm, I don't think my DNS provider supports that, but I suspect that is
not the issue in this case, as the request gets to readthedocs.org
<http://readthedocs.org>, it's the server that's giving the 404.
The webserver at readthedocs.org needs the canonical name
(formencode.readthedocs.org) for resolving the project. This works only
with a CNAME entry or probably with DNAME as well.
-- Christoph
------------------------------------------------------------------------------
Special Offer -- Download ArcSight Logger for FREE!
Finally, a world-class log management solution at an even better
price-free! And you'll get a free "Love Thy Logs" t-shirt when you
download Logger. Secure your free ArcSight Logger TODAY!
http://p.sf.net/sfu/arcsisghtdev2dev
_______________________________________________
FormEncode-discuss mailing list
https://lists.sourceforge.net/lists/listinfo/formencode-discuss
David Stanek
2011-08-27 21:37:22 UTC
Permalink
Post by David Stanek
Where can I find out what users have push access?
When you're owner or admin of the repo,
Bitbucket should show a tab "Admin".
Right, but I was hoping to be able to see that without being an admin. That
way I could add everyone to the new repo. Do you happen to know who has
write access to Ian's repo?
--
David
blog: http://www.traceback.org
twitter: http://twitter.com/dstanek
www: http://dstanek.com
Christoph Zwerschke
2011-08-27 22:20:08 UTC
Permalink
Post by David Stanek
Right, but I was hoping to be able to see that without being an admin.
That way I could add everyone to the new repo. Do you happen to know who
has write access to Ian's repo?
I have, but don't know who else has. Seems Ian needs to give you admin
rights or transfer the access rights over to the new repo himself.

-- Christoph
Christoph Zwerschke
2011-08-28 09:52:08 UTC
Permalink
There are already 2 changesets which need to be applied to the
official one,
Ok, I can now push to the official repo and already pushed the 2 missing
changesets (the last 2 were mistakes and needn't be pushed).

-- Christoph
Loading...