Jump to content

Frameworks/Epics/Apidox refresh: Difference between revisions

From KDE Community Wiki
Randomguy3 (talk | contribs)
Aurélien (talk | contribs)
Line 21: Line 21:
|-
|-
{{FeatureInProgress|Deploy new scripts on api.kde.org| Alex Merry}}
{{FeatureInProgress|Deploy new scripts on api.kde.org| Alex Merry}}
{{FeatureTodo|Decide where to host documentation policy.
{{FeatureDone|Decide where to host documentation policy.


There is currently
Agreed on this plan:
http://techbase.kde.org/Policies/Library_Documentation_Policy for kdelibs4.


Proposal:
* Existing /Policies/Library_Documentation_Policy renamed to /Policies/KDE4_Library_Documentation_Policy
* Creation of a /Policies/Frameworks_Documentation_Policy
* /Policies/Library_Documentation_Policy points to both pages


* Copy `Library_Documentation_Policy` to `KDE4_Library_Documentation_Policy`.
| Aurélien Gâteau }}
* Link to it from `Library_Documentation_Policy`.
{{FeatureTodo|Execute said plan| Aurélien Gâteau }}
* Update `Library_Documentation_Policy` to contain KF5 documentation.
{{FeatureTodo|Document framework.yaml and README.md files| Aurélien Gâteau }}
 
Alternative:
 
* Create a 'Frameworks_Documentation_Policy' based on 'Library_Documentation_Policy'
| ??}}
{{FeatureTodo|Document framework.yaml and README.md files| ??}}
|}
|}



Revision as of 09:54, 5 February 2014

On framework themselves

Status Task Contact
IN PROGRESS Migrate Mainpage.dox to README.md (see also: Necessary files) Alex Merry
DONE Standardize documentation dir ("dox" vs "docs", image dir) Alex Merry

On kapidox tools

Must Have

Status Task Contact
IN PROGRESS Deploy new scripts on api.kde.org Alex Merry
DONE Decide where to host documentation policy.

Agreed on this plan:

  • Existing /Policies/Library_Documentation_Policy renamed to /Policies/KDE4_Library_Documentation_Policy
  • Creation of a /Policies/Frameworks_Documentation_Policy
  • /Policies/Library_Documentation_Policy points to both pages


Aurélien Gâteau
TO DO Execute said plan Aurélien Gâteau <{{{3}}}>
TO DO Document framework.yaml and README.md files Aurélien Gâteau <{{{3}}}>

Nice to Have

Status Task Contact
TO DO Integrate generation of dependency diagrams in kgenframeworksapidox ?? <{{{3}}}>
TO DO Define a way to list undocumented elements ?? <{{{3}}}>
TO DO Look into the search system, evaluate a client-side only system. Rationale: more uniform, easier to test. ?? <{{{3}}}>