See attached .pdf for revision suggestions to the page.

CommentFileSizeAuthor
node_202799 edits.pdf69.58 KBvegantriathlete

Comments

vegantriathlete’s picture

vegantriathlete
he/him/his
Primary language English
Location Lakewood, CO
commented

I forgot to mention that the document has strikeouts, highlights, and notes in {} to indicate the suggested revisions.

figaro’s picture

figaro commented

It is actually better to create a diff of the HTML you have reviewed and approved: http://drupal.org/patch/create
That way the documentation team is better able to apply your patch.

vegantriathlete’s picture

vegantriathlete
he/him/his
Primary language English
Location Lakewood, CO
commented

I'm a little confused. These are changes to a handbook page. I'm not rolling a patch. If I had access to the edit tab on the page, I would make the changes myself.

Are you suggesting that I do a view page source and save the HTML and do a diff on that?

I thought I was following the proper protocol for filing a documentation change. Please clarify.

figaro’s picture

figaro commented

Yes, but just the bit that you made changes on, not the whole page.

vegantriathlete’s picture

vegantriathlete
he/him/his
Primary language English
Location Lakewood, CO
commented

@figaro - that seems a bit beyond what the documentation team has asked for. Is there some other node from the documentation team I should be reading?

vegantriathlete’s picture

vegantriathlete
he/him/his
Primary language English
Location Lakewood, CO
commented
Status: Active » Needs review
figaro’s picture

figaro commented

It's fine. It is best if the documentation team picks this up. Thank you for your efforts nonetheless.

arianek’s picture

arianek commented
Status: Needs review » Needs work

thanks for the faq page revisions - you're right vegantriathlete, we don't normally roll patches for handbook pages, but we also don't normally work off of uploaded pdf's (not really the best workflow for reviewing text or making the edits).

since this is a large chunk of edits, i would suggest that you post the proposed edits as plain HTML text into a comment on this issue, wrapped in <code> tags, and then we can review the text and copy/paste it a lot easier.

thanks!

Chas Belov’s picture

Chas Belov
he/him
commented

(Long post) I notice the Drupal FAQ page, the subject of this issue, has a lot of "here" links as well as other links that appear to provide insufficient context. This does not follow the link style for Drupal.org, causes accessibility issues, and causes some people including myself usability issues.

I suggest the following changes (in addition to the original poster's changes):

Change 

<dd>We've set up <a href="/handbook/is-Drupal-right-for-you" rel="nofollow">a page</a> to specifically answer this question.</dd>

to

<dd>We've set up a page to specifically answer the question as to <a href="/handbook/is-Drupal-right-for-you" rel="nofollow">when Drupal is a good choice.</a></dd>

Change 

<dd>Drupal is pretty light on system resources, being based on PHP. The only <q>restriction</q> currently is on the database - you must use either one from MySQL or PosgreSQL. You can check the detailed system requirements <a href="/requirements" rel="nofollow">here</a>.</dd>

to

<dd>Drupal is pretty light on system resources, being based on PHP. The only <q>restriction</q> currently is on the database - you must use either one from MySQL or PosgreSQL. Check the <a href="/requirements" rel="nofollow">detailed system requirements</a>.</dd>

Change 

<dd>There is <a href="/node/26669" rel="nofollow">a guide</a> for this purpose.</dd>

to

<dd>There is <a href="/node/26669" rel="nofollow">a guide to making offline copies of Drupal.org documentation</a>.</dd>

Change 

<dd>You can use the <a href="/project/project_issue" rel="nofollow">issue tracking system</a> of Drupal. To file new issues, go <a href="/node/add/project_issue/Drupal" rel="nofollow">here</a>.</dd>

to

<dd>You can use the <a href="/project/project_issue" rel="nofollow">issue tracking system</a> of Drupal to <a href="/node/add/project_issue/Drupal" rel="nofollow">file a new issue</a>.</dd>

Change 

<dd>It is impossible to single out each site that uses Drupal.. However, you can find a partial list <a href="http://www.Drupalsites.net/" rel="nofollow">here</a>.</dd>

to

<dd>It is impossible to single out every site that uses Drupal.. However, there is a <a href="http://www.Drupalsites.net/" rel="nofollow">partial list of Drupal-using sites</a>.</dd>

Change 

<dd>Lately, many books on Drupal are being published. You can find an incomplete list <a href="/books" rel="nofollow">here</a>.<br />

to

<dd>Lately, many books on Drupal are being published. There is an <a href="/books" rel="nofollow">incomplete list of Drupal books</a>.<br />

Change 

<br />
Read more about weights <a href="/node/110238" rel="nofollow">here</a>.</dd>

to

<br />
<a href="/node/110238" rel="nofollow">Read more about weights</a>.</dd>

Change 

<br />
Read more about backing up your Drupal site <a href="/node/22281" rel="nofollow">here</a>.</dd>

to

<br />
<a href="/node/22281" rel="nofollow">Read more about backing up your Drupal site</a>.</dd>

Change 

<br />
For more information, read the <a href="/node/101009" rel="nofollow">.info</a> page.</dd>

to

<br />
For more information, read the <a href="/node/101009" rel="nofollow">.info file documentation</a>.</dd>

Change 

<br />
We have set up a <a href="/node/51220" rel="nofollow">page</a> specifically for this file.</dd>

to

<br />
For more information, read the <a href="/node/51220" rel="nofollow">.install file documentation</a>.</dd>

Change 

<br />
For more information on this module, read the <a href="/project/akismet" rel="nofollow">project page</a> of akismet.</dd>

to

<br />
For more information on this module, read the <a href="/project/akismet" rel="nofollow">akismet project page</a>.</dd>

Change 

<dd>Drupal includes built-in methods for implementing JavaScript. You can read more about it <a href="/node/121997" rel="nofollow">here</a>.</dd>

to

<dd>Drupal includes built-in methods for implementing JavaScript. You can read <a href="/node/121997" rel="nofollow">Drupal's JavaScript implementation documentation</a>.</dd>

Change 

<br />
You can read more about it at its <a href="/project/multidomain" rel="nofollow">project page</a>.</dd>

to

<br />
You can read more about it at the  <a href="/project/multidomain" rel="nofollow">Multiple Domains project</a> page.</dd>

Change 

<dd>Yes, there is <a href="/project/recaptcha" rel="nofollow">a module</a> specifically for that.</dd>

to

<dd>Yes, there is <a href="/project/recaptcha" rel="nofollow">the reCAPTCHA module</a> specifically for that.</dd>

Change 

<br />
You can read more about it at its <a href="/project/views" rel="nofollow">project page</a>.<br />
A tutorial is available <a href="/node/63230" rel="nofollow">here</a>.</dd>

to

<br />
You can read more about it at the <a href="/project/views" rel="nofollow">Views project page</a>.<br />
A <a href="/node/63230" rel="nofollow">views tutorial</a> is also available.</dd>

Change 

<dd>There is a fantastic guide <a href="http://stephenondrupal.blogspot.com/2007/10/set-up-wiki-with-drupal-5.html" rel="nofollow">here</a>.</dd>

to

<dd>There is a fantastic guide to <a href="http://stephenondrupal.blogspot.com/2007/10/set-up-wiki-with-drupal-5.html" rel="nofollow">how to set up a wiki with Drupal</a>.</dd>

Change 

<dd>Of course, you are welcome to join us on IRC. You will find <a href="http://drupal.org/irc" rel="nofollow">here</a> a list of Drupal IRC Channels where we hang out on #drupal at <a href="http://freenode.net" rel="nofollow">freenode</a>.<br />

to

<dd>Of course, you are welcome to join us on IRC. You will find a <a href="http://drupal.org/irc" rel="nofollow">list of Drupal IRC Channels</a> where we hang out on #drupal at <a href="http://freenode.net" rel="nofollow">freenode</a>.<br />

Change 

<br />You can read more about Zen at its  <a href="/project/zen" rel="nofollow">project page</a>.</dd>

to

<br />You can read more about this at the  <a href="/project/zen" rel="nofollow">Zen project page</a>.</dd>

Change 

However, the design decision was made for a number of reasons, you can <a href="http://api.Drupal.org/api/file/developer/topics/oop.html" rel="nofollow">read more</a> about this issue.</dd>

to

However, the design decision was made for a number of reasons, you can read more about <a href="http://api.Drupal.org/api/file/developer/topics/oop.html" rel="nofollow">the decision not to use OOP</a>.</dd>

Change 

<p>You can read more about it at <a href="http://buytaert.net/drupal-trademark-policy-forthcoming" rel="nofollow">Dries' blog</a>.</dd>

to

<p>You can read more about it at <a href="http://buytaert.net/drupal-trademark-policy-forthcoming" rel="nofollow">Dries' blog post on the trademark issue</a>.</dd>

Change 

<dd>The bluebeach theme will not be released. Please understand that it is done so only to protect the Drupal brand identity! You can <a href="/node/27367" rel="nofollow">read more</a> about this issue.</dd>

to

<dd>The bluebeach theme will not be released. Please understand that it is done so only to protect the Drupal brand identity! You can read more about <a href="/node/27367" rel="nofollow">the Drupal theme</a>.</dd>

Change 

<dd>You can check out the server specs <a href="" rel="nofollow">(Hardware Info-page have to be updated)</a></dd>

to

<dd>You can check out the server specs once the Hardware Info page has been updated.</dd>

(End)

vegantriathlete’s picture

vegantriathlete
he/him/his
Primary language English
Location Lakewood, CO
commented

Okay, so I finally got around to finishing the edits. I had started them so long ago and, wouldn't you know it, there was only about three minutes worth of work left! Anyway, here they are:

I am not in a position to donate money. Can I help in any other way?
We understand that not everyone can donate money. However, you can still help in many other ways&8212;coding, writing documentation, testing patches etc. Please read the Contribution Page to find something that interests you.
Why does Drupal need a database? What databases are supported?
Drupal stores its information&8212;the individual pages, the registered users, and so on&8212;in the database. The database forms the back-end for your Drupal site. At this time, Drupal supports only MySQL and PostgreSQL.
What are the system requirements for my Drupal server?
Drupal is pretty light on system resources, being based on PHP. The only restriction currently is on the database&8212;you must use either one from MySQL or PosgreSQL. You can check the detailed system requirements here.
Why are so many Drupal versions available&8212;4.x, 5.x ...? Which one should I use?
It is recommended that you run the most current stable release. This can always be found at the Drupal Project page. However, if there are no compelling features in the latest version, a contrib module that is important to you isn't ready or you don't have time, there is no need to rush your upgrade as long as security updates are available for the version you are running. For more information, refer to the Version info page.
Why should I use Drupal, and not any other CMS? How does Drupal compare to Joomla, ...
It is hard for us to give an unbiased reply to that :)
However, recently a lot of articles have been written for comparing CMS's. Use your favorite search engine. You can also try CMSMatrix.
Also, here is an article comparing Drupal specifically with Joomla.
OK, so Drupal is great. What <del>all</del> sites use it?
It is impossible to single out each site that uses Drupal.. However, you can find a partial list here.
What is a sandbox? How do I set up one for my Drupal site?
<del>From wikipedia - </del>According to <a href="http://en.wikipedia.org/wiki/Sandbox_%28software_development%29" rel="nofollow">Wikipedia</a>,Sandbox is an online environment in which code or content changes can be tested without affecting the original system.
New features and modules are demonstrated best in a sandbox. You may use demo module to setup a demonstration site.
Are backups essential in Drupal? How do I backup my site?
Like any other media, backups are essential. From the Drupal site&8212;If a site's data does not exist in three places, it doesn't exist at all.
Read more about backing up your Drupal site here.
What are Drupal modules?
A module is a collection of functions that link into Drupal, providing additional functionality to your Drupal installation.
There is a tutorial available<del>,</del> on the topic Creating Modules.
After reading this tutorial, you will be able to create a basic block module and use it as a template for more advanced modules and node modules.
What are .info files, and how do I write them?
.info files are used primarily by the modules administration system for display purposes as well as providing criteria to control activation and deactivation. This file is required for Drupal 5 to recognize the presence of a module.
For more information, read the .info page.
I need to show my code to others. Can I paste it directly into the channel?
Please do not paste lots of code directly into the channel&8212;it disrupts the flow of conversation. Please use one of the many pastebin services&8212;a nice one to use would be DrupalBin.
Is there any code convention or coding style that Drupal suggests?
Yes&8212;The Drupal Coding Standards. Please follow them carefully when submitting any code for inclusion in Drupal project.
figaro’s picture

figaro commented
Status: Needs work » Needs review

Changing status

vegantriathlete’s picture

vegantriathlete
he/him/his
Primary language English
Location Lakewood, CO
commented

Thanks! I just realized that I had forgotten to change that and was coming in to do so.

arianek’s picture

arianek commented

hi vegantriathlete, that's great work -

like i mentioned in comment #8 if you can just post straight html of the updated text inside code tags, that would make it *much* easier to update!

thanks!

vegantriathlete’s picture

vegantriathlete
he/him/his
Primary language English
Location Lakewood, CO
commented

I guess I need some clarification. I thought that I did post straight HTML wrapped in code tags. What did I do wrong?

I was giving the other information to provide context. Did you want my changes to be formatted more like comment #9?

How about if you take one of my changes and show how you would prefer it to be formatted?

arianek’s picture

arianek commented

hey -

no, if it was in code tags, it actually shows all the html, so yes like you did in #9, but just paste the whole finished updated text as a chunk, not with bits to delete and such.

basically, i just want to be able to copy the completed html over to the handbook page. makes sense?

vegantriathlete’s picture

vegantriathlete
he/him/his
Primary language English
Location Lakewood, CO
commented
I am not in a position to donate money. Can I help in any other way?

<dd>We understand that not everyone can donate money. However, you can still help in many other ways&8212;coding, writing documentation, testing patches etc. Please read the <a href="/contribute" rel="nofollow">Contribution Page</a> to find something that interests you.</dd>

Why does Drupal need a database? What databases are supported?

<dd>Drupal stores its information&8212;the individual pages, the registered users, and so on&8212;in the database. The database forms the &lt;code>back-end&lt;/code> for your Drupal site. At this time, Drupal supports only MySQL and PostgreSQL.</dd>

What are the system requirements for my Drupal server?

<dd>Drupal is pretty light on system resources, being based on PHP. The only <q>restriction</q> currently is on the database&8212;you must use either one from MySQL or PostgreSQL. You can check the detailed system requirements <a href="/requirements" rel="nofollow">here</a>.</dd>

<dt id="whysomany">Why are so many Drupal versions available&8212;4.x, 5.x ...? Which one should I use?</dt>

It is recommended that you run the most current stable release. This can always be found at the Drupal Project page. However, if there are no compelling features in the latest version, a contrib module that is important to you isn't ready or you don't have time, there is no need to rush your upgrade as long as security updates are available for the version you are running. For more information, refer to the Version info page.
Why should I use Drupal, and not any other CMS? How does Drupal compare to Joomla, ...
<dd>It is hard for us to give an unbiased reply to that :)<br />
However, recently a lot of articles have been written for comparing CMS's. Use your favorite search engine. You can also try <a href="http://www.cmsmatrix.org/" rel="nofollow">CMSMatrix</a>.<br />
Also, here is an <a href="http://cmsreport.com/node/543" rel="nofollow">article</a> comparing Drupal specifically with Joomla.</dd>

<dt id="sitesusing">OK, so Drupal is great. What sites use it?</dt>

It is impossible to single out each site that uses Drupal.. However, you can find a partial list here.
What is a sandbox? How do I set up one for my Drupal site?
<dd>According to <a href="http://en.wikipedia.org/wiki/Sandbox_%28software_development%29" rel="nofollow">Wikipedia</a>,<q>Sandbox is an online environment in which code or content changes can be tested without affecting the original system.</q><br />
New features and modules are demonstrated best in a sandbox. You may use <a href="/project/demo" rel="nofollow">demo module</a> to setup a demonstration site.</dd>
Are backups essential in Drupal? How do I backup my site?
<dd>Like any other media, <em>backups are essential</em>. From the Drupal <a href="/node/22281" rel="nofollow">site</a>&8212;If a site's data does not exist in three places, it doesn't exist at all.<br />
Read more about backing up your Drupal site <a href="/node/22281" rel="nofollow">here</a>.</dd>
What are Drupal modules?
<dd>A module is a collection of functions that link into Drupal, providing additional functionality to your Drupal installation.<br />
There is a tutorial available on the topic <a href="/node/82920" rel="nofollow">Creating Modules</a>.<br />
After reading this tutorial, you will be able to create a basic block module and use it as a template for more advanced modules and node modules.</dd>
What are .info files, and how do I write them?
<dd>.info files are used primarily by the modules administration system for display purposes as well as providing criteria to control activation and deactivation. This file is required for Drupal 5 to recognize the presence of a module.<br />
For more information, read the <a href="/node/101009" rel="nofollow">.info</a> page.</dd>
I need to show my code to others. Can I paste it directly into the channel?

<dd>Please do not paste lots of code directly into the channel&8212;it disrupts the flow of conversation. Please use one of the many pastebin services&8212;a nice one to use would be <a href="http://drupalbin.com" rel="nofollow">DrupalBin</a>.</dd>

Is there any code convention or coding style that Drupal suggests?

<dd>Yes&8212;<a href="/coding-standards" rel="nofollow">The Drupal Coding Standards</a>. Please follow them carefully when submitting any code for inclusion in Drupal project.</dd>

arianek’s picture

arianek commented
Status: Needs review » Fixed

close enough ;-) amended the page, with a couple small formatting changes to meet styleguide. thanks for the editing work!

vegantriathlete’s picture

vegantriathlete
he/him/his
Primary language English
Location Lakewood, CO
commented
Status: Fixed » Needs review

I'm confused. Most of the changes I made were directed towards using the &8812; and removing the spaces on either side according the the Numbering, hyphens, dates section in the Handbook Style Guide. It appears that you have stripped all of those changes out.

arianek’s picture

arianek commented

I *just* stripped out the instances of &8812; about an hour ago, when I went back to make another (unrelated) edit because they were not being parsed and were showing up just as the entity number. I have no idea why they weren't working, but it looked terrible, so they had to go. (I didn't even notice initially when I did the updates because the page is so long.)

arianek’s picture

arianek commented
Status: Needs review » Fixed

Status: Fixed » Closed (fixed)

Automatically closed -- issue fixed for 2 weeks with no activity.

grahamtk’s picture

grahamtk commented
Component: Correction/Clarification » Other documentation issues
Priority: Normal » Major
Status: Closed (fixed) » Needs review

Hi!
I found this thread touching both the work on the documentation / FAQ of Drupal,
and someone mentioning cmsmatrix.org. I hope you see the importance of my request even if it might be misplaced - and if it is misplaced, because of the importance, help me find where I should ask.

I am in the process of choosing an OSS CMS solution, and I see many mentions of cmsmatrix.org.
When comparing my candidates on cmsmatrix I see that drupal is lacking a lot of support for the compared features.

The lack of support is not real - I know, from my experience with drupal the features are not missing neither in drupal or its extentions -it is the outdated info about drupal on cmsmatrix.org that is causing the bad compare result.

All the other candidates had very recent listings, and thus I fear that drupal suffers from this outdated info.

I hope someone seasoned in Drupal and its documentation and / or functionality could update the info on CMSmatrix.org.

Best regards,
from a fan of Drupal.

arianek’s picture

arianek commented
Status: Needs review » Fixed
Issue tags: +drupal.org content audit

can you please file a new issue regarding this with a link to the specific page this info should be fleshed out on? thanks.

arianek’s picture

arianek commented
Issue tags: -drupal.org content audit

oops didn't mean to tag, removing

Status: Fixed » Closed (fixed)

Automatically closed -- issue fixed for 2 weeks with no activity.