Frameworks/Epics/Apidox refresh: Difference between revisions

Latest revision as of 14:26, 1 April 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
DONE	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
DONE	Execute said plan	Aurélien Gâteau
DONE	Document framework.yaml and README.md files	Aurélien Gâteau

Nice to Have

Status	Task	Contact
DONE	Integrate generation of dependency diagrams in kgenframeworksapidox	Aurélien Gâteau
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}}}>

@@ Line 8: / Line 8: @@
 |-
 {{FeatureInProgress|Migrate Mainpage.dox to README.md (see also: [[../KF5.0_Release_Preparation/Necessary_Files|Necessary files]]) | Alex Merry}}
-{{FeatureTodo|Standardize documentation dir ("dox" vs "docs", image dir)| ??}}
+{{FeatureDone|Standardize documentation dir ("dox" vs "docs", image dir)| Alex Merry}}
 |}
@@ Line 20: / Line 20: @@
 !  width=250 | Contact
 |-
-{{FeatureTodo|Deploy new scripts on api.kde.org| ??}}
+{{FeatureDone|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`.
+{{FeatureDone|Execute said plan| Aurélien Gâteau }}
-* Update `Library_Documentation_Policy` to contain KF5 documentation.
+{{FeatureDone|Document framework.yaml and README.md files| Aurélien Gâteau }}
-| ??}}
-{{FeatureTodo|Document framework.yaml and README.md files| ??}}
 |}
@@ Line 43: / Line 42: @@
 !  width=250 | Contact
 |-
-{{FeatureTodo|Integrate generation of dependency diagrams in kgenframeworksapidox| ??}}
+{{FeatureDone|Integrate generation of dependency diagrams in kgenframeworksapidox| Aurélien Gâteau }}
 {{FeatureTodo|Define a way to list undocumented elements| ?? }}
 {{FeatureTodo|Look into the search system, evaluate a client-side only system. Rationale: more uniform, easier to test.| ??}}
 |}