I really want to update the ctools documentation page but noticed it does not exist.

I would like to request for a documentation page to be created for ctools and also have it linked form the project page (https://www.drupal.org/project/ctools). That way users can add to the documentation and get involved!

Also once created I can add the documentation I currently have on the module.
Thanks!

Comments

batigolix’s picture

Project: Documentation » Ctools
Component: Missing documentation » Code

I'm assigning this issue to the ctools module queue, to get feedback if documentation already exists. (I searching via google and drupal.org but nothing showed up)

@courtneyjordan: If it doesn't exist already, you can create it somewhere in the documentation hierarchy (needs to reviewed what would be a proper place for this)

courtneyjordan’s picture

@batigolix: Thanks for the quick response! Yeah i've looked around Drupal.org and was unable to locate any documentation on the module.

Would I beable to update my ticket project title to documentation hierarchy and add my documentation here or where you referring to a specific location within drupal.org?

batigolix’s picture

Let's wait a couple of more days for feedback from the ctools maintainer(s). Maybe (well hidden) docs exist somewhere. In the meantime we can do a bit more googling to see if something pops up.

If no docs appear then:
- a. we should figure out a good location in the community docs (chaos) hierarchy
- b. add a first page (you mentioned you had material already written about this module?)

batigolix’s picture

I found this: https://www.drupal.org/node/1234770 which kind of answers all our questions.

Apparently there is 'advanced help' docs for ctools & inline documentation.

I'd propose to create a ctools entry somewhere in the community docs section and explain there how and where to find docs.
Now lets find out where to add it.

courtneyjordan’s picture

Sounds good. I do have some documentation written up but i'm going to locate the advanced help with ctools as mentioned in the link above and revise what i have.

Thank you for all your help Batigolix!

batigolix’s picture

This would be the most appropriate parent:
https://www.drupal.org/documentation/structure

@courtneyjordan: I leave to you the honor of creating the child page & first documentation entry page for cTools on d.o. ever.

As discussed: we should explain on that page where to *find* documentation (like they do in https://www.drupal.org/node/1234770)
After that we can add your material, but let's see what the overlap is with existing docs.

There is a reason that there is no documentation on drupal.org and only in Advanced Help: the original maintainer of Ctools is also the creator of the Advanced Help module and he preferred to document his modules as such.

courtneyjordan’s picture

@batigolix: Will do and thanks!

I looked over the documentation in the advanced help module and it covered most of what I had written minus a few topics. I'll review what I have with a fine tooth comb and add what hasn't been covered. I'll also make sure to write out easy to follow steps on how to use the advanced help module to view the ctools documentation.

batigolix’s picture

Great, post the link here as soon as you have created the page

courtneyjordan’s picture

Link to Ctools documentation https://www.drupal.org/node/2356405

As I work more with the module I will add more documentation.
Thank you once again @batigolix for all your help! I'm sure the community will enjoy the results.

courtneyjordan’s picture

@batigolix: I wanted to touch base to see where we are with getting the documentation link onto the ctools project page.
If there is anything else you need form me to move this forward please let me know. Thanks!

batigolix’s picture

Title: Creation of ctools Documentation Page » Creation of ctools Documentation Page & add link from ctool project page

I think for the moment that is it. This issue should be picked up by the maintainers at some point. I'll ping them via their contact form to get their attention.

tim.plunkett’s picture

Project: Ctools » Chaos Tool Suite (ctools)
Version: » 7.x-1.x-dev
Component: Code » Documentation

It is either ctools or CTools, never Ctools.

Also this issue was filed against https://www.drupal.org/sandbox/japerry/2179357, which may be why no one saw it.

courtneyjordan’s picture

Thanks for the input Tim! I've updated the documentation to reflect the name change.
I also wanted to touch base to see if the documentation was going to be referenced on the ctools project page.
If there is anything I can do to help move this item forward please let me know.

Thanks guys!

courtneyjordan’s picture

.

courtneyjordan’s picture

@tim & @batigolix,

Is anything else needed to push this item? If further changes are needed please let me know, thanks.

courtneyjordan’s picture

Status: Active » Closed (fixed)
courtneyjordan’s picture

This has been opened for a year so i'm just going to close it. The documentation for the item can be found here: https://www.drupal.org/node/2356405

I'll leave it up to the maintainers of ctools if they'd like to link it from their project page.