Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New/udpated doc pending 1.2 release #2040

Closed
mattab opened this issue Jan 20, 2011 · 13 comments
Closed

New/udpated doc pending 1.2 release #2040

mattab opened this issue Jan 20, 2011 · 13 comments
Labels
Critical Indicates the severity of an issue is very critical and the issue has a very high priority. Task Indicates an issue is neither a feature nor a bug and it's purely a "technical" change.
Milestone

Comments

@mattab
Copy link
Member

mattab commented Jan 20, 2011

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

@mattab
Copy link
Member Author

mattab commented Jan 20, 2011

#2015 FAQ update and possibly config setting rename

@mattab
Copy link
Member Author

mattab commented Jan 20, 2011

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

@mattab
Copy link
Member Author

mattab commented Jan 20, 2011

Also mention the following deprecated:

  • removed: setDownloadClass() - deprecated; see setDownloadClasses()
  • removed: setLinkClass() - deprecated; see setLinkClasses()

@mattab
Copy link
Member Author

mattab commented Jan 20, 2011

#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
Copy link
Member Author

mattab commented Feb 12, 2011

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
Copy link
Member Author

mattab commented Feb 13, 2011

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

@mattab
Copy link
Member Author

mattab commented Feb 19, 2011

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
Copy link
Member Author

mattab commented Feb 19, 2011

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
Copy link
Contributor

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

@mattab
Copy link
Member Author

mattab commented Feb 22, 2011

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
Copy link
Contributor

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

@mattab
Copy link
Member Author

mattab commented Feb 22, 2011

OK sounds good vipsoft!!

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

Any feedback most welcome!!

@mattab
Copy link
Member Author

mattab commented Feb 22, 2011

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

@mattab mattab added this to the Piwik 1.2 milestone Jul 8, 2014
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Critical Indicates the severity of an issue is very critical and the issue has a very high priority. Task Indicates an issue is neither a feature nor a bug and it's purely a "technical" change.
Projects
None yet
Development

No branches or pull requests

2 participants