Problem/Motivation
When a d.o user has created a new project (in this case, a sandbox project) the instructions for what to do next are no longer correct, now that Drupal 8 is the preferred release of Drupal:
* Create a 7.x-1.x branch.
* Write "name = ..." to a .info file.
The out-of-date information can be seen in the screenshot below.
At the very least, this could be confusing or a barrier to best practices; at worst, this could discourage potential new contributors.
Proposed resolution
Identify the component responsible for this boilerplate text and patch it with alternative text.
Consider retaining some information on how to start a Drupal 7 project (i.e. referencing a .info file rather than a .info.yml file.)
Remaining tasks
tbc.
User interface changes
None: documentation only.
API changes
None.
Data model changes
None.
Comment | File | Size | Author |
---|---|---|---|
#8 | instructions_for_how_to-2835029-8.patch | 1.3 KB | jp.stacey |
Version control for sandbox foo.png | 153.08 KB | jp.stacey |
Comments
Comment #2
jp.stacey CreditAttribution: jp.stacey at Magnetic Phield commentedComment #3
drummComment #4
drummDrupal.org currently has these string overridden with variable_set, which I wouldn’t mind getting rid of. The code in this module looks like it is updated for the 8.x branch name, but not the info file format.
Comment #5
jp.stacey CreditAttribution: jp.stacey at Magnetic Phield commented@drumm thanks for forwarding this on to the right project (yours!)
It looks from the source like the branch issue has been fixed in the two "Empty*repository" functions:
function project_git_instructions_new_maintainer()
function project_git_instructions_sandbox_new_maintainer()
But the old .info file is still referenced, not .info.yml; and the details piped into it wouldn't be sufficient for a working project (name, description, type, core.) Would
cat - > @project_fullname.info.yml
be a better way to handle so many values?Comment #6
jp.stacey CreditAttribution: jp.stacey at Magnetic Phield commented(Ah, sorry, snap.)
Comment #7
drummI wouldn’t send people who are on average newer to terminals straight to
cat - >
. Maybe switch to a one-lineREADME.txt
?Comment #8
jp.stacey CreditAttribution: jp.stacey at Magnetic Phield commented@drumm that would be fine - anything to get them moving so they can refresh the page and go on to the next step, I guess?
With that in mind, patch attached for comment.
Comment #10
drummLooks good, deploying shortly.
Comment #11
drummThis has been deployed to Drupal.org.