Contributors
Writers
- alannaburke
- drnikki
- yesct
- cleverington
- bradleyfields
Editors
- cottser
- drnikki
- yesct
- cleverington
- sugaroverflow
Editing
Edit current pages using MarkDown via GitHub, or Git by submitting pull requests.
Contributors should be added to the in the @drupal-diversity organization on GitHub. They can then use the in-browser editing feature for existing pages: Drupal Developer Resources - In-Browser Editing
Copy-Edit Guidelines
The Drupal Documentation Team recently published the Drupal 8 User's Guide.
See the definitions of writer
and editor
in the GLOSSARY.md.
This Book will follow the guidelines outlined in the Style Guide
- Drupal.org/docs: User Guide Contributor Guidelines
- Drupal.org/docs: User Guide Contributor Guidelines - Preface
- Drupal.org/docs: User Guide Contributor Guidelines - Chapter 1. Instructions for contributors
- Drupal.org/docs: User Guide Contributor Guidelines - Chapter 2. Guidelines
- Drupal.org/docs: User Guide Contributor Guidelines - Chapter 3. Instructions for project managers
Example Pages
- Drupal 8 User Guide - 2.1. Concept: Regions in a Theme
- Drupal 8 User Guide - 2.5. Planning your Content Structure
Note - We are following the above guidelines, but we will be using GitHub-flavored Markdown, not ASCII-DOC.
The Drupal 8 User's Guide was loosely based on the Drupal.org style guide.
Including 'New' Pages
When adding new pages to the Book
, update the SUMMARY.md
file for them to be recognized by GitBook.
Creating Links
[https://www.drupal.org/community](https://www.drupal.org/community "Title Text")
Adding Images
![Druplicon](../images/druplicon-small.png "Druplicon")
If the images are in a directory, add the directory:
At times, the image may fail to load, even if deployed properly. Submit an issue requesting image correction and we can help link it.
![Druplicon](../images/random-directory/druplicon-small.png "Druplicon")
Be Accessible. Remember the Alt-Text!
Adding YouTube Videos
Take a look at this video:
{% youtube %}https://www.youtube.com/watch?v=oHg5SJYRHA0{% endyoutube %}
- drnikki
- yesct
- cleverington
- sugaroverflow
Editing
Editing current pages can be done using MarkDown via GitHub, or Git by submitting pull requests.
Authorized contributors added into the @drupal-diversity organization on GitBook can use the in-browser editing feature for existing pages: Drupal Developer Resources - In-Browser Editing
Copy-Edit Guidelines
The Drupal Documentation Team recently published the Drupal 8 User's Guide and the associated writing / editing documentation used.
See the definitions of writer
and editor
in the GLOSSARY.md.
This Book will follow the guidelines outlined in the Style Guide
- Drupal.org/docs: User Guide Contributor Guidelines
- Drupal.org/docs: User Guide Contributor Guidelines - Preface
- Drupal.org/docs: User Guide Contributor Guidelines - Chapter 1. Instructions for contributors
- Drupal.org/docs: User Guide Contributor Guidelines - Chapter 2. Guidelines
- Drupal.org/docs: User Guide Contributor Guidelines - Chapter 3. Instructions for project managers
Example Pages
- Drupal 8 User Guide - 2.1. Concept: Regions in a Theme
- Drupal 8 User Guide - 2.5. Planning your Content Structure
Note - Though we are following the above guidelines, we will be using GitHub-flavored Markdown (as noted above) instead of ASCII-DOC (as used by the Drupal Documentation Team).
The style guide created for the Drupal 8 User's Guide was loosely based on the Drupal.org style guide, available at https://www.drupal.org/drupalorg/style-guide/content.
Including 'New' Pages
When adding new pages to the Book
, they need to be updated in the SUMMARY.md
file in order to be recognized by GitBook.
Creating Links
[https://www.drupal.org/community](https://www.drupal.org/community "Title Text")
Adding Images
![Druplicon](../images/druplicon-small.png "Druplicon")
If the images are in a directory, add the directory:
At times, the image may fail to load, even if deployed properly. Submit an issue requesting image correction and we can help link it.
![Druplicon](../images/random-directory/druplicon-small.png "Druplicon")
Be Accessible. Remember the Alt-Text!
Adding YouTube Videos
Take a look at this video:
{% youtube %}https://www.youtube.com/watch?v=oHg5SJYRHA0{% endyoutube %}