By request of arianek, I have re-written a script to update the Core modules documentation page.

It's in Bash; it's messy; it's sensitive to the way the issues page formats its options; but it works.

CommentFileSizeAuthor
#10 core_modules.txt4.57 KBpillarsdotnet
#9 core_modules.txt4.59 KBpillarsdotnet
#8 core_modules.txt4.46 KBpillarsdotnet
#7 core_modules.txt4.38 KBpillarsdotnet
#5 core_modules.txt4.38 KBpillarsdotnet
#1 core_modules.txt3.88 KBpillarsdotnet
core_modules.txt3.83 KBpillarsdotnet

Comments

pillarsdotnet’s picture

pillarsdotnet commented
StatusFileSize
new core_modules.txt3.88 KB

Fixed an error that prevented links to module documentation pages from working correctly.

pillarsdotnet’s picture

pillarsdotnet commented
Status: Closed (fixed) » Needs review
jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

I notice that on the current page, the Doc links don't go anywhere. Not sure if that is coming from the script or if was pre-existing?

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

Also, probably any modules in "test" subdirectories should be removed, and the modules named in the left column should not be links? Again, not sure if I am critiquing the page or the script, but the names in the left column look like links, but they don't go anywhere.

pillarsdotnet’s picture

pillarsdotnet commented
StatusFileSize
new core_modules.txt4.38 KB

I notice that on the current page, the Doc links don't go anywhere. Not sure if that is coming from the script or if was pre-existing?

That was from the first version of the script. I just uploaded the results of the revised version linked in #1.

Also, probably any modules in "test" subdirectories should be removed,

Why? They have documentation, and sometimes that documentation is useful. How about I move them to the bottom as a separate table, instead?

the modules named in the left column should not be links?

Mouse over the short-name to see the human-readable name. But the short-name is required to be unique, whereas several of the test modules have duplicate human-readable names.

Again, not sure if I am critiquing the page or the script,

In the linked posting on g.d.o, Ariane said:

Hiya - it would probably be useful if you could post this somewhere to aid with keeping the page up to date! Maybe post it in here? http://drupal.org/node/302146

... but the names in the left column look like links, but they don't go anywhere.

Until d.o. allows javascript or CSS this is the best I can do.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

Ah, much better!

Regarding the left column... The page is not very wide as it is. How about making a separate column for the human-readable module names (and putting it first, before the machine name, which is only useful to developers I think)? That would be more accessible and obvious to more readers, I think.

+1 on the separation between regular and test modules.

pillarsdotnet’s picture

pillarsdotnet commented
StatusFileSize
new core_modules.txt4.38 KB

Okay, but the result is a little messy, because where I said "Human-readable name" above I should have said "Module description".

pillarsdotnet’s picture

pillarsdotnet commented
StatusFileSize
new core_modules.txt4.46 KB

This looks better, I think.

pillarsdotnet’s picture

pillarsdotnet commented
StatusFileSize
new core_modules.txt4.59 KB

Better yet.

pillarsdotnet’s picture

pillarsdotnet commented
StatusFileSize
new core_modules.txt4.57 KB

Okay, I think I'm done for now.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

Wow, nice work! I think this is good to go. Waiting for Ariane's 2nd opinion to mark RTBC though.

pillarsdotnet’s picture

pillarsdotnet commented

Although I couldn't be more pleased to get a positive review of the results, I will candidly admit that the script which produced them is ... less than optimal.

So if there is any real chance of deploying this for some kind of automated update, it really ought to be rewritten by someone who is much smarter than I am.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

I am not sure we really need an automatic update. We're talking about *core* modules here, and they don't change often enough to warrant an automatic update in my opinion. As long as the script can be run every once in a while, it should be OK?

pillarsdotnet’s picture

pillarsdotnet commented

Okay with me; I'm just following the leader here.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Project: Drupal core » Documentation
Version: 8.x-dev »
Component: documentation » Docs infrastructure
Issue tags: +docs infrastructure

This is in the wrong issue queue by the way.

pillarsdotnet’s picture

pillarsdotnet commented

Sorry about that.

Do we have a documentation page describing this fine distinction?

The shoemaker's children have no shoes.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

Yes, there is documentation that states that Drupal Core issues are about Drupal Core code, and Documentation issues are about the on-line documentation. Do you want me to locate it for you, or are you just asking to make sure I know it should be documented?

pillarsdotnet’s picture

pillarsdotnet commented

No; if you say it exists, I can probably find it on my own.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Needs review » Fixed

I have attached this script to the page, and I think we can consider this issue fixed. Thanks again!

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