Submission guidelines
By registering you can add your favorite tips to share with the Drupal community.
A tip is a short text that describes simple steps to improve a Drupal site (optimization, theming, going live, etc.).
This web site is intended to be a quick and easy to use cheatsheet / checklist. And this is the way your submitted tips have to be: quick and easy to read.
Every tip should be unique, so first search for an existing one before beginning your submission.
As a Drupal user / developper / themer or whatever, the submission form for tips should look familiar. The form is only composed of 4 parts, described above.
Title
Enter a short title, please be brief. The more important, type someting meaningful, think of your tip. Ask yourself the following question: "Does this title is understable without reading the body of my tip?". Good examples would be: "Enable cache" or "Create a page not found (404) landing page".
Vocabularies
In this fieldset you will select differents terms, presented as follow:
- Topic: what your tip is about,
- Drupal version: select the good ones,
- Tags: you already know how it works!
Body
This field will contain your tip description. When I write description, I mean the answer of your tip title. Go straight to the goal. Always take shortcuts. We are not here to replace the Drupal.org documentation nor all the wonderful howto's and contrib documentation available out there.
When possible, try to use bullet points, please always try to avoid long blabla sentences.
Here is an example, lets consider we defined a title Enable Drupal caching. From my point of view, a perfect tip description could look like this:
- Go to Administer > Site configuration > Performance
- Set Caching Mode to Normal or Aggressive
- Set Block cache to Enabled (recommended)
- Save your settings.
You can additionaly use the editor toolbar to format your text or highlight your code snippets as shown below.
Resources
This is again something you are used to.
Resources are web links pointing to helpful pages or module project pages. If you are treating an SEO tip, it could be helpful that you link your tip to the Metatags module project page.
A link is composed of an URL and a title.
And voilà!
Your tip is now show on the lastest page.
Drupal-check.org is a wiki thing
As a registered user you can edit any tip to improve it or correct typos. So please, be smart, polit and respectful with others submissions.
