As pointed out in #1892548: Official documentation pages missing for new Drupal 8 Modules documentation is missing for new core modules among them Transliteration.

Tasks:

  1. Create docs page for module under url http://drupal.org/documentation/modules/transliteration
  2. Notify maintainer(s) & request technical review
  3. Notify technical authors and request style review
  4. (If a project page exists) Ask for a link from project page
  5. Review if correctly placed in docs outline
  6. Reference in http://drupal.org/node/1283408

Comments

batigolix’s picture

batigolix’s picture

5.) the docs page needs a better place in the docs outline. it is currently filed under "Managing URLs" but it does more than that

batigolix’s picture

Issue summary: View changes

rotten li

batigolix’s picture

2) the docs needs a technical review. See also notes in #1853390: Document that transliteration is in D8 core

jhodgdon’s picture

Transliteration is *not* a module in Drupal 8 actually. It was a contributed module in Drupal 7, but in Drupal 8 it is not technically a module.

jhodgdon’s picture

Status: Needs work » Fixed

I reviewed the docs on http://drupal.org/documentation/modules/transliteration and edited them a bit, especially the part about Drupal 8.

I agree that it doesn't belong where it is in the Documentation book outline system. The page is primarily about the Drupal 7 contrib module Transliteration. I believe it has three main uses:
- It modifies file names when you upload files. For that use case, it should belong in a section about managing file uploads. I do not see this section in the Documentation... no idea?
- Developers can use it if they need transliteration in their programming. For that use case, it should be in a section about APIs provided by contributed modules.
- Some other modules require it. For that use case, we wouldn't (I think) really even need a docs page for it. It's just something that you have to install in order to use the other module that does what you want it to do. That is probably why it is in the URLs section now, because it is required by (I think?) pathauto.

Since I know where this page should go if it's primarily for developers, I put it under Contributed APIs: https://drupal.org/node/342809 -- and if it is moved, I think a link should be added to the body of the Contributed APIs page that links to the Transliteration page.

Provisionally marking this "fixed". Feel free to move it to a section about file upload management if you know where that should be.

And by the way I am one of the maintainers of the transliteration system (not a module) in Drupal 8. So I think all the items in the issue summary checklist have been taken care of.

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

Anonymous’s picture

Issue summary: View changes

added 2 to do's