The 2026 Drupal Business Survey is open. Your response will help shape the future of the Drupal business ecosystem.Problem/Motivation
The AMP project recommends the following headings for AMP conversion projects:
- How to install AMP software/tool
- How to enable AMP
- How to disable AMP
- How UI format is modified upon AMP conversion
In addition, the AMP project prefers the term Structured Data rather than AMP Metadata.
The current README does not yet follow these guidelines.
Proposed resolution
Update the README file to follow these documentation guidelines.
Remaining tasks
- Provide updated README
- Allow for review of updated README
User interface changes
None.
API changes
None.
Data model changes
None.
| Comment | File | Size | Author |
|---|---|---|---|
| #13 | 2850002-12.patch | 24.93 KB | keshavv |
| #11 | 2850002-11-additional-readme-changes.patch | 6.49 KB | rainbowarray |
| #7 | interdiff-2850002-5-7.txt | 14.81 KB | rainbowarray |
| #7 | 2850002-7-update-readme-based-on-guidelines.patch | 22.93 KB | rainbowarray |
Comments
Comment #2
rainbowarrayAn initial patch with updated README documentation. This also updates the README to better explain how to install AMP with a Composer-based Drupal project, as the Composer Manager method is now outdated.
Comment #3
karens commentedI haven't tried running through the steps yet but I have a few suggestions:
- Totally remove the comments about using Composer Manager, it's just confusing since that's no longer the right way to do things.
- The phrase "AMP tools" is confusing, it sounds like there is some other module called "AMP tools". The language people are most used to would be something like "AMP module and its dependencies".
Also looking at this fresh after a long period away from it, it's kind of overwhelming. Architectural details are in the summary, installation steps are buried in the middle. It might benefit from some re-organization. Maybe something like this:
1. A very very brief overview of the module
2. How to install the module and its dependencies
3. The bare minimum configuration steps
4. More information, architectural overview, additional configuration options and other details you might want to dig into once you have a minimum installation working.
I'm going to try a fresh install and will post my thoughts after that.
Comment #4
karens commentedOne more thing. If you don't upload a logo for the sub theme the page won't work, as noted in https://www.drupal.org/node/2829783, so mentioning that step is critical.
I'll have a rewrite ready to post soon.
Comment #5
karens commentedHere is my suggested patch, which incorporates the changes I discussed above.
Comment #6
rainbowarrayInterdiff for #5 for reference.
Comment #7
rainbowarrayAdditional updates based on feedback.
Comment #9
rainbowarrayI merged the README updates for now. Further updates can be made moving forward. Next will be updating this for 7.x.
Comment #10
rainbowarraySome additional changes are necessary for the D8 README.
Comment #11
rainbowarrayAdditional changes that need to be committed as per guidelines from the AMP project.
Comment #13
keshavv commentedRe-roll patch with drupal 8 documentation standard. Please review
Comment #14
keshavv commentedComment #15
karens commentedI'd actually prefer to update the Drupal.org documentation instead and update the README to just point to it. It's going to be easier to keep documentation straight in a single location.
Comment #16
karens commentedDocumentation has been pulled out of READ and moved to the D.O. documentation pages in 8.3. Earlier branches won't be getting updated.