Task #3977

Task #4103: review documentation pages for deliverable D10.1

Review Accounting Framework Wiki Pages for Deliverable D10.1 purpose

Added by Luca Frosini over 3 years ago. Updated over 3 years ago.

Status:ClosedStart date:May 10, 2016
Priority:HighDue date:
Assignee:Gabriele Giammatteo% Done:

100%

Category:Default
Sprint:WP10
Infrastructure:
Milestones:
Duration:


Related issues

Related to BlueBRIDGE - Project Task #700: T10.3 Federated Resources Management [Months: 1-29] Closed Mar 07, 2016 Apr 30, 2016

History

#1 Updated by Luca Frosini over 3 years ago

  • Subject changed from Review Accounting Wiki Page for Deliverable D10.1 purpose to Review Accounting Framework Wiki Pages for Deliverable D10.1 purpose

#2 Updated by Nunzio Andrea Galante over 3 years ago

  • Related to Task #4103: review documentation pages for deliverable D10.1 added

#3 Updated by Nunzio Andrea Galante over 3 years ago

  • Related to deleted (Task #4103: review documentation pages for deliverable D10.1)

#4 Updated by Nunzio Andrea Galante over 3 years ago

  • Parent task deleted (#701)

#5 Updated by Nunzio Andrea Galante over 3 years ago

  • Parent task set to #4103

#6 Updated by Nunzio Andrea Galante over 3 years ago

  • Assignee changed from Gabriele Giammatteo to Luca Frosini

Online guide of this component is going to be part of deliverable D10.1 (D101_BlueBRIDGE_Resources_Federation_Facilities). In the effort of homogenizing the guide content for all services described, we created a list of topics that should be covered for each service:

  • Overview (high level functionalities and key features of the implementation)
  • Usage Scenarios, Use Cases, Usage Instructions (User Guide)
  • Architecture, Design, Implementation, Code Examples (Developer Guide)
  • Installation and Configuration (Administration Guide)

An example of structured page can be found at https://gcube.wiki.gcube-system.org/gcube/FHNManager

From a quick review of wiki page:

The following content seems to be missing and should be added:

  • Overview (high level functionalities and key features of the implementation)
  • Usage Scenarios, Use Cases, Usage Instructions (User Guide)
  • Code Examples (Developer Guide)
  • Installation and Configuration (Administration Guide)

Of course, level of detail and proportions of each section could be different depending on the type of component (e.g. Portlets will have a User Guide much more detailed than the installation section). Furthermore, for convenience this content might be organized in different ways in the page structure and/or split in different pages.

Please make your changes as soon as possible in order to be able to include them in the deliverable.

#7 Updated by Nunzio Andrea Galante over 3 years ago

  • Priority changed from Normal to High

#8 Updated by Leonardo Candela over 3 years ago

  • Status changed from New to In Progress

#9 Updated by Leonardo Candela over 3 years ago

  • % Done changed from 0 to 10

#10 Updated by Leonardo Candela over 3 years ago

  • % Done changed from 10 to 90
  • Assignee changed from Luca Frosini to Gabriele Giammatteo
  • Status changed from In Progress to Feedback

The page has been revised. I'm not convinced the proposed "template" is suitable. Please, do notice the page you are referring to is expected to be a "features" page while other parts are more suitable for "guide" pages (it seems you are alluding to them yet it is suggested that these are in the same Wiki page).

#11 Updated by Gabriele Giammatteo over 3 years ago

  • % Done changed from 90 to 100
  • Status changed from Feedback to Closed

indeed, my request was not to have everything in the same page (it is fine to have the content "split" in different pages - features and guide pages), just to have all the content navigable from the homepage of the deliverable with links from D10.1 or links from the other component's pages.

#12 Updated by Luca Frosini over 3 years ago

  • Related to Project Task #700: T10.3 Federated Resources Management [Months: 1-29] added

Also available in: Atom PDF