{"id":23043359,"url":"https://github.com/theodorosploumis/drupal-manual","last_synced_at":"2025-07-04T19:05:12.585Z","repository":{"id":61029610,"uuid":"263008811","full_name":"theodorosploumis/drupal-manual","owner":"theodorosploumis","description":"A skeleton to generate User Guide (manual) for Drupal Administrators (non-developers).","archived":false,"fork":false,"pushed_at":"2022-10-08T08:27:36.000Z","size":79,"stargazers_count":3,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-17T13:52:48.404Z","etag":null,"topics":["documentation","drupal","hacktoberfest","user-guide"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/theodorosploumis.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-05-11T10:19:14.000Z","updated_at":"2025-03-05T08:09:58.000Z","dependencies_parsed_at":"2022-10-08T20:25:34.397Z","dependency_job_id":null,"html_url":"https://github.com/theodorosploumis/drupal-manual","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/theodorosploumis/drupal-manual","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theodorosploumis%2Fdrupal-manual","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theodorosploumis%2Fdrupal-manual/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theodorosploumis%2Fdrupal-manual/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theodorosploumis%2Fdrupal-manual/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/theodorosploumis","download_url":"https://codeload.github.com/theodorosploumis/drupal-manual/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theodorosploumis%2Fdrupal-manual/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263603137,"owners_count":23487211,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","drupal","hacktoberfest","user-guide"],"created_at":"2024-12-15T20:47:18.257Z","updated_at":"2025-07-04T19:05:12.565Z","avatar_url":"https://github.com/theodorosploumis.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Drupal site - User Guide (Manual)\n\u003e A simple skeleton to create a (printed) User Guide (manual) for Drupal Site Administrators (non-developers, non User 1). \n\nCheck https://github.com/theodorosploumis/php-docs to see how this guide is used on a real Drupal project.\n\n## About\nHave you ever created a Drupal site and need to provide a **written (printed)** documentation for the site Admins, Managers or Authors? This project is for you. \"*How to add a new Page*\", \"*How to Promote a Node on Front Page*\" etc are some of the questions that need answer in a User Guide. \n\nA lot of administrative tasks in Drupal may have the same UI and similar options. For example when you create a Node by default you see on the form fields like `Title`, `URL Alias`, `Promoted to front page` etc. The documentation for these fields can be generic for every site.\n\nOf course, there is the core module [Tour](https://www.drupal.org/docs/8/core/modules/tour) that can help users with inline popups but this will not work for printed manuals.\n\n---\n\n## See also\n\n- [Drupal.org - User Guide project (asciidoc files)](https://www.drupal.org/project/user_guide)\n- [Drupal.org - User Guide PDF](https://www.drupal.org/docs/understanding-drupal/user-guide-e-book-downloads)\n- [Drupal.org - Glossary](https://www.drupal.org/docs/user_guide/en/glossary.html)\n\n---\n\n## Requirements\n- Use markdown, json or yml files as source.\n- Organize User Guide pages in folder structure.\n- Use a static generator to build the Guide (hugo, gatsby, grav etc).\n- Allow reader to download each User User Guide page or the whole document as pdf, html, odt.\n\n---\n\n## Options and Fields\n\n### Node Options\n\n(Create a a common doc file for these options which are usually the same for every Drupal site. Most of the options appear from contributed modules. The same options may appear for **Media or other custom Content entities**).\n\n- View\n- Edit\n- Delete\n- Create (Add new)\n- Publish/Unpublish\n- Preview\n- Replicate\n- Create Revision\n- View Revisions\n- Revert Revisions\n- Compare Revisions\n\n---\n\n### Paragraphs Options\n(Create a a common doc file for these options which are usually the same for every Drupal site. Most of the options appear from contributed modules.)\n\n- View\n- Edit\n- Delete (Remove)\n- Create (Add new)\n- Preview\n- Move up/down (change weight)\n- Duplicate\n- Collapse\n- Add Above\n\n---\n\n### Webform Options\n(Create a a common doc file for these options which are usually the same for every Drupal site. These options appear from the webform module.)\n\n- View\n- Submit\n- Edit\n- Delete\n- Resend (submit with the existing values)\n- Test\n- Notes (add administrative notes)\n\n---\n\n### Menu Options\n(Create a a common doc file for these options which are usually the same for every Drupal site. These options appear from the core menu module.)\n\n- View menu links\n- Add new menu link\n- Change weight of menu links\n- Edit a menu link\n- Delete a menu link\n- Enable/Disable a menu link\n- Show as expanded\n- (Alternative way to alter a menu link)\n\n---\n\n### Node Form Fields\n\n(Create a a common doc file for these options which are usually the same for every Drupal site. Some of the fields appear from contributed modules.)\n\n- Title\n- Create Revision\n- Menu Settings\n- Metatags\n- URL Alias\n- URL Redirects\n- Simple XML Sitemap\n- Authored by (author)\n- Authored on (created date)\n- Promoted to front page\n- Sticky at top of lists\n- Published\n- **CUSTOM FIELDS (eg Paragraph fields, images etc...)**\n\n---\n\n## Templates\n- [Page Template](/templates/page.md)\n- [Entity Metadata Template](/templates/entity_metadata.md)\n\n---\n\n## TOC\nAn example of Table of Contents for a Drupal site User Guide.\n\n1. Introduction\n   * Table of Content\n   * Cover, Date created, Owner, Logos and legal notices\n   * Requirements and prior knowledge to use these Guides\n2. General\n   * Login\n   * Reset Password\n3. Content: Nodes\n   * Manage Nodes (Views page explanation)\n   * Node options (Actions explanation)\n   * Node form visual guide (View-Mode VS Form 1-1 visual mapping)\n   * Paragraph TypeA Fields (View-Mode VS Form 1-1 visual mapping)\n4. Content: Media/MyEntity etc\n   * Manage (see above)\n   * Options (see above)\n5. Content: Taxonomy\n   * Manage (see above)\n   * Options (see above)\n6. Content: Blocks\n   * (Same as above)\n7. Dynamic Pages\n   * Views Page A (how it selects data)\n   * Views Block B (how it selects data)\n8. Forms\n   * FormA\n     * View FormA Results table\n     * Download FormA results\n     * Purge (Clean) FormA results\n     * Each Result of FormA Actions\n9. Menus\n   * MenuA\n     * Add menu link\n     * Edit menu link\n     * Delete menu link\n     * Change weight of a menu link\n     * Disable/Enable a menu link\n     * Expand a menu link\n10. Settings\n    * Clear Caches\n    * Performance Settings\n    * Google Analytics\n    * Global metatags\n    * URL Aliases\n    * URL Redirects\n    * Site Settings\n    * System Users\n      * Add User\n      * Edit User\n      * Delete User\n11. Appendix\n    * Using the CKEditor\n    * Using Contextual links module\n    * Using Quick Edit module (quickedit)\n    * Styleguide: Basic CSS styles (Heading, link, button, list, blockquote, image, embed etc)\n    * Styleguide: CKEditor custom styles (with visual mapping)\n    * Styleguide: Dynamic Views from real Drupal Entity in several view modes\n    * Node Anatomy\n    * All data Fields by usage in Entities\n    * Paragraph Anatomy\n    * Paragraph View-Mode VS Form 1-1 visual mapping (for every type)\n    * What is Drupal CMS\n    * (Drupal) Terminology/Glossary (eg What are Nodes, Fields, Taxonomy, Blocks, Users, Paragraphs, View Modes, Caches, CKEditor, Accessibility, HTML)\n    * Drupal.org documentation links etc\n\n---\n\n## Tips\n- Do not change the official Drupal terminology. Eg use the word \"Node\" for content pages. Let your readers learn about Drupal.\n- Try to use the default Drupal 8.x admin theme (Seven) or a subtheme based on this. It seems that Seven has the best (UX \u0026 UI) support for all the contributed modules. This will make also the screenshots reusable across projects.\n- Browser used for screenshots should not have plugins enabled that may affect styling or inputs (eg the LastPass plugin that adds buttons on input)\n- Avoid keywords and phrases that are too specific. This will make the manuals reusable.\n- Make the texts easy to replace with a simple search and replace process.\n- Screenshots should contain only the Main Content region (not sidebars etc) except if you use these regions on the Node Forms.\n- Screenshots should not contain the Admin Toolbar or other non related UI elements except if needed.\n- Screenshots should use a small - medium device width (eg up to 1200px screen).\n- Screenshots of Forms with too many fields or Admin Pages with too many tasks Tasks should split to additional Guide Pages.\n- Take individual Screenshots of each element form to create a more detailed Guide.\n- Use `masquerade` Drupal module to become the user you create the manuals for.\n- Don't explain everything in screenshots that are not so important or never used by users (eg do not explain all the advanced `google_analytics` module settings).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftheodorosploumis%2Fdrupal-manual","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftheodorosploumis%2Fdrupal-manual","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftheodorosploumis%2Fdrupal-manual/lists"}