@mattab opened this Issue on January 20th 2011 Member

This ticket lists all doc updates we will make to FAQ/docs when 1.2 is released.

@mattab commented on January 20th 2011 Member

#2015 FAQ update and possibly config setting rename

@mattab commented on January 20th 2011 Member

IMPORTANT: advertise clearly that piwik_log is now deprecated. Remove legacy doc page from the website. Advertise this in changelog + blog post.

@mattab commented on January 20th 2011 Member

Also mention the following deprecated:

  • removed: setDownloadClass() - deprecated; see setDownloadClasses()
  • removed: setLinkClass() - deprecated; see setLinkClasses()
@mattab commented on January 20th 2011 Member

#1984 Documentation needed for Custom variables JS API

Also, nice to have: a doc page with a use case/example, and screenshot for this new feature.

@mattab commented on February 12th 2011 Member

piwik_log is not deprecated anymore, good news.

Left to do:

  • Anthon: JS API new functions documentation
  • Matt: Custom vars JS api + setup use case on piwik.org (for future user doc page)
  • Matt: Segmentation API documentation, update http://piwik.org/docs/analytics-api/reference and link to the new segment page + add quick example combining AND and OR
  • mention deprecated JS methods in changelog
@mattab commented on February 13th 2011 Member

Put Custom Variables doc in http://piwik.org/docs/javascript-tracking/#toc-custom-variables - any feedback?

@mattab commented on February 19th 2011 Member

One more FAQ to update: http://piwik.org/faq/new-to-piwik/#faq_104

About sub domains / multiple websites tracking. We should explain the cookie requirements in a sentence or link to the JS doc (which will explain in more details each function)

@mattab commented on February 19th 2011 Member

I updated the Analytics API page: http://piwik.org/docs/analytics-api/reference/ with the new segment doc in: http://piwik.org/docs/analytics-api/segmentation/

Problem is that the demo is down at the moment unfortunately. I asked for reboot...

@robocoder commented on February 20th 2011 Contributor

I've updated http://piwik.org/docs/javascript-tracking/ with all the API changes, and fixed some typos/formatting issues.

@mattab commented on February 22nd 2011 Member

FAQ was updated http://piwik.org/faq/new-to-piwik/#faq_104

which is now pointing to the new Cookie configuration doc: http://piwik.org/docs/javascript-tracking/#toc-cookies-configuration-for-domains-and-sub-domains

Also the list of functions and parameters at the bottom was updated.

Btw, would there be any way to generate the JS API page of the piwik.js object using phpdoc? It would be cool to have auto generated documentation for the public functions

@robocoder commented on February 22nd 2011 Contributor

there's jstophpdoc to convert to phpdoc format, and jsdoc. I.ll look into this after my code tweaks.

@mattab commented on February 22nd 2011 Member

OK sounds good vipsoft!!

Added user doc for Custom Variables: http://piwik.org/docs/custom-variables/

Any feedback most welcome!!

@mattab commented on February 22nd 2011 Member

I think appart from a few notices in the changelog, all user doc has been created & updated, good stuff

This Issue was closed on February 22nd 2011
Powered by GitHub Issue Mirror