Saturday, November 7, 2009

[infrastructure] [task] Enable checkout view in Viewvc

Issue status update for
http://drupal.org/node/618720
Post a follow up:
http://drupal.org/comment/reply/618720#comment-form


Project: Drupal.org infrastructure
Component: CVS
Category: task
Priority: normal
Assigned to: Narayan Newton
Status: active
Updated by: dman

Just Disagree.
I have two [1] complex modules both of which /are distributed with/
several pages of HTML documentation, including references, walkthrough,
examples, illustrations and a case study. When you get the module, you
get the support docs - in the spirit of GNU. You don't get told to go
somewhere else for docs that may or may not refer to the current
version.


This extensive HTML support is available through the Drupal 'help'
menu, through context links in the UI, through viewing the files
directly in your own preferred OS filemanager, and - until recently -
*in a version controlled and publicly bookmarkable URL* you could browse
before or separately from the install itself.


Even linking to a README (and I go way beyond that) is an /improvement/
on the state of most modules publicly-visible pre-install support. When
evaluating a module that does NOT publish its README up-front, I will
sometimes go directly to the repository to hunt it down and see it, to
get an idea of the assumptions and requirements. This is why removing
the previously-useful feature from the repository disappoints me.
It may be that this handy utility was not the intended primary purpose
of having the repository browsable, :-) but it's real, and has been
useful for this.

[1] http://drupal.org/project/import_html

dman


Original issue:
------------------------------------------------------------------------
Friday, October 30, 2009 - 20:59 : joachim

Module builder module relies on downloading hook documentation files
with URLs like this:


http://cvs.drupal.org/viewvc/drupal/contributions/docs/developer/hooks/c...
[2]


The recent upgrade of Viewvc appears to block checkout view, meaning my
module can't get the data it needs to function.


Please could it be reenabled?

[2]
http://cvs.drupal.org/viewvc/drupal/contributions/docs/developer/hooks/core.php?view=co&pathrev=DRUPAL-6--1

Previous comments (20):
------------------------------------------------------------------------
#1 -- Friday, October 30, 2009 - 21:02 : joachim
http://drupal.org/node/618720#comment-2208266

Original bug on MB: #618436: CVS path and view parameter are wrong
everywhere [3].

[3] http://drupal.org/node/618436
------------------------------------------------------------------------
#2 -- Saturday, October 31, 2009 - 01:17 : greggles
http://drupal.org/node/618720#comment-2208786

Changing title to reduce freak-out-factor and state the desired action.


According to the docs [4] this is now called File Download and is
disabled in the default configuration but can be enabled.

[4] http://cvs.drupal.org/viewvc-static/help_rootview.html
------------------------------------------------------------------------
#3 -- Saturday, October 31, 2009 - 02:58 : joachim
http://drupal.org/node/618720#comment-2209132

Yes please!


I don't mean to freak the maintainers, but the absence of this does
break a module that a lot of people use for development. I'd very much
appreciate it if it could be turned back on soon, as I'm partway through
work on this.

------------------------------------------------------------------------
#4 -- Saturday, October 31, 2009 - 03:03 : greggles
http://drupal.org/node/618720#comment-2209148

I debated about bringing this up earlier, but since you did....


"
does break a module that a lot of people use for development.


"
There are 170 people who use it. [5].

[5] http://drupal.org/project/usage/module_builder
------------------------------------------------------------------------
#5 -- Saturday, October 31, 2009 - 04:12 : joachim
http://drupal.org/node/618720#comment-2209404

Since the module is meant to be used on development sites only, my guess
is that most installations that have it don't have updates turned on.
Also, the drush version of the module lives in drush, so won't get
picked up either.


Since you say :)

------------------------------------------------------------------------
#6 -- Saturday, October 31, 2009 - 05:04 : dman
http://drupal.org/node/618720#comment-2209608

Please, there are other reasons too!


I have many times been able to just download the missing file from a
CVS project with one click - very good.


When supporting dev stuff in the forums, I link folk directly to the
CVS folder and say 'download this file and replace the one you've got'
to help them avoid CVS headaches and waiting for bundles to roll.


But MOST importantly, I use it to link to embedded documentation that
comes with my modules [6] because maintaining a handbook page in
parallel is boring, and this way I keep my docs up-to-date and visible.


Right now, we can't even download resources [7] from there like we used
to!


This is a real set-back for me :(

[6] http://drupal.org/project/taxonomy_xml
[7]
http://cvs.drupal.org/viewvc/drupal/contributions/docs/marketing/logo/
------------------------------------------------------------------------
#7 -- Saturday, October 31, 2009 - 05:43 : Gerhard Killesreiter
http://drupal.org/node/618720#comment-2209732

Note that I find it a bit strange that somebody writes a module that
relies on a service from drupal.org that could go away / be changed any
time without discussing this with the infrastructure team.


I understand the general desire to download files through the GUI and
we will investigate if we can enable this. However it is possible that
we'll conclude that it is not.

------------------------------------------------------------------------
#8 -- Saturday, October 31, 2009 - 05:47 : merlinofchaos
http://drupal.org/node/618720#comment-2209744

Note that it is common to check screenshots into CVS as part of the
package, and then link the 'screenshots' (and README as well) link on
the module page to the CVS version.

------------------------------------------------------------------------
#9 -- Saturday, October 31, 2009 - 06:12 : joachim
http://drupal.org/node/618720#comment-2209846

> Note that I find it a bit strange that somebody writes a module that
relies on a service from drupal.org that could go away / be changed any
time without discussing this with the infrastructure team.


@Gerhard Killesreiter
Take it up with webchick, AFAIK she wrote module builder originally, I
just inherited it with the slurping from ViewCVS already there.

------------------------------------------------------------------------
#10 -- Saturday, October 31, 2009 - 06:19 : Gerhard Killesreiter
http://drupal.org/node/618720#comment-2209870

Hmm, if it is that ancient, she may actually have asked me and I forgot
it. :p

------------------------------------------------------------------------
#11 -- Saturday, October 31, 2009 - 06:51 : phayes
http://drupal.org/node/618720#comment-2209970

+1 for dmans comments. Being able to copy-pasta code snippets directly
from the web is incredibly helpful for day to day kind of module
development without having to do a seach on the version you want in the
web interface, mark down the revision version, then jump over to cvs to
do the checkout in order to get plaintext.

------------------------------------------------------------------------
#12 -- Saturday, October 31, 2009 - 08:15 : Narayan Newton
http://drupal.org/node/618720#comment-2210264

Just to explain this a bit. We are aware this is useful. However, this
is a security issue. We are looking into ways to make checkout view
secure, but right now its not and thus is disabled.


-N

------------------------------------------------------------------------
#13 -- Saturday, October 31, 2009 - 11:12 : webchick
http://drupal.org/node/618720#comment-2210756

Apparently that auto-download feature in module builder is so old that
neither killes nor I remembers it. ;D Much easier user-experience-wise
than having to explain to people how to do a checkout of
contributions/docs/developer/hooks, though, that's for sure.


However, I too find this inconvenient for my day-to-day development
life. I'm used to being able to browse code in viewcvs and
copy/paste/the contents. Now, though, I need to actually checkout the
project in question locally in order to do this, since a page such as
http://cvs.drupal.org/viewvc/drupal/contributions/modules/uc_views/views...
[8] shows line numbers, which copy/paste as well. :( (otherwise,
though, those line numbers are really useful!)


Would love if the 'download' option could be re-instated, for all of
the other reasons mentioned as well (screenshots, not having to
duplicate README.txt in the handbook and update it in two places,
etc...).


Is there anything we "lesser" people can do to help this along? :) Or
just be patient while the infrastructure team looks into it?

[8]
http://cvs.drupal.org/viewvc/drupal/contributions/modules/uc_views/views/uc_views.views.inc?revision=1.13.2.5.2.6&view=markup&pathrev=DRUPAL-6--3
------------------------------------------------------------------------
#14 -- Monday, November 2, 2009 - 12:45 : drewish
http://drupal.org/node/618720#comment-2215434

+1 on restoring this behavior. i'm now stuck at a job with a proxy that
blocks cvs access so how am i supposed to grab a copy of
cvs-release-notes.php [9]? i can't very well copy paste since it's long
and each line is prefixed by the line number.

[9]
http://cvs.drupal.org/viewvc/drupal/contributions/tricks/cvs-release-notes/cvs-release-notes.php?revision=1.8&view=markup
------------------------------------------------------------------------
#15 -- Tuesday, November 3, 2009 - 07:21 : roychri
http://drupal.org/node/618720#comment-2218308

The module dreditor [10] contains a link to install the script and that
link depends on Checkout view. That link is called "Click to Install or
Update" under the Installation section of the project page.


When I try to install dreditor, I get:


Error loading user script:
403: Forbidden


If this checkout view cannot be enabled, some alternative would be
useful.

[10] http://drupal.org/project/dreditor
------------------------------------------------------------------------
#16 -- Wednesday, November 4, 2009 - 04:39 : hyrcan
http://drupal.org/node/618720#comment-2221622

I beleive this issue is the cause of some images are getting 403
Forbidden due to "Checkout view is disabled"


For example:
http://drupal.org/node/9068 [11]
http://drupal.org/druplicon [12] (node/254)


Not sure how widely used this is across drupal.org though, maybe just
these two pages.

[11] http://drupal.org/node/9068
[12] http://drupal.org/druplicon
------------------------------------------------------------------------
#17 -- Thursday, November 5, 2009 - 12:02 : Narayan Newton
http://drupal.org/node/618720#comment-2228058

So here is the deal. We are going to put viewvc on a different domain
which will make us able to re-enable the checkout view. However, until
that happens we are going to have to keep it disabled. Its too large a
vulnerability.

------------------------------------------------------------------------
#18 -- Thursday, November 5, 2009 - 12:07 : dman
http://drupal.org/node/618720#comment-2228066

OK, that's something :-)
Thanks for fixing this!

------------------------------------------------------------------------
#19 -- Saturday, November 7, 2009 - 15:09 : dman
http://drupal.org/node/618720#comment-2237404

duplicate #625872: How can I read the documentation for this? Drupal 5
[13]

[13] http://drupal.org/node/625872
------------------------------------------------------------------------
#20 -- Saturday, November 7, 2009 - 21:52 : joachim
http://drupal.org/node/618720#comment-2238030

Linking to your CVS's README by way of documentation is cheating! ;)
[14]

[14]
http://www.drupaler.co.uk/blog/six-reasons-get-handbook-page-your-module/460

--
[ infrastructure | http://lists.drupal.org/mailman/listinfo/infrastructure ]

0 评论: