cernopendata / opendata.cern.ch

Source code for the CERN Open Data portal
http://opendata.cern.ch/
GNU General Public License v2.0
656 stars 147 forks source link

Meeting August 28th #41

Closed suenjedt closed 10 years ago

suenjedt commented 10 years ago

These texts are being prepared by CMS, with the support of Patricia. They should be linked (initially) on the right hand side of the individual records with a dedicated box. Patricia will investigate if parts of this information can be referenced in the metadata to enable the tailoured dataset specific display. This additional documentation will sit, however, on an additional page and should be exportable as a PDF. It should be a record by itself, get a DOI, incl. citation recommendation (Action on Patricia to prepare that).

Ana's analysis


Overall tasks and next steps

UX/UI testing tasks

Metadata related tasks

katilp commented 10 years ago

Just a clarification for the second point: for the guided tour, to start with, this document will be the same for all primary data sets (may change later). But it will be different for derived data sets (e.g. the instructions connect to derived "pattuples" from ana will point to code and the instructions of how to run)

suenjedt commented 10 years ago

Thanks Kati, changed that :)

RaoOfPhysics commented 10 years ago

@pherterich, @suenjedt, @katilp: Please confirm a suitable time for the documentation sprint next week. Options for me: http://doodle.com/e5sgctgu5mxunuki#calendar

katilp commented 10 years ago

Further elaboration of the four information areas which should accompany each element on the portal:

1) where did this come 2) how was it validated 3) how to use it 4) limitations

For primary data set these would contain 1) trigger selections 2) general statement on the data validation (eventually, in the future, validation plots which will be needed if the the data or the software need to be migrated) 3) guided tour doc with explanations on the data content and on how to do an analysis) 4) whatever needed....

For derived data sets 1) code that was used to produced them starting from the primary data sets 2) eventually an expected result to which to compare after step 3) 3) pointer to application (event display, histogramming, analysis example code) and the instructions 4) whatever needed (i.e. physcis object selections may not be the offcial recommendations of CMS etc...)

For the VM image 1) some explanation of how the image was built (i.e. link to CernVM...) 2) Anssi's report 3) prerequisite text from https://twiki.cern.ch/twiki/bin/view/CMS/DPOAVMUserInstructions#Prerequisites 4) unsolved problems found by Anssi if any

For the CMSSW code example (i.e. those to produce the event display files, Ana's two levels) 1) statement that this code runs in CMSSW version N 2) eventually, a reference plot or a result or expected output from step 3) 3) instructions on how to run 4) whatever needed...

For the applications (i.e. histogramming, event display, else) 1) what are the underlying packages, tools 2) a reference plot/figure of after running step 3) 3) pointer to a source code and instructions on how to run (needed for "external" developers 4) whatever needed

RaoOfPhysics commented 10 years ago

@suenjedt, @katilp, @pherterich: We meet

on 2 September (Tuesday) at 15:00 in R1

(Unless you prefer a proper meeting room?)

TimSmithCH commented 10 years ago

In addition to the disclaimer, all data records should have clearly marked the copyright statement and licence for reuse

suenjedt commented 10 years ago

Indeed, the official label for CCZero, which is the one being used here (so far) is available here http://creativecommons.org/about/downloads

katilp commented 10 years ago

Do we already have an area for editing the Additional information text in github?

suenjedt commented 10 years ago

@tiborsimko : you mentioned this easy editing functionality for html stuff here we could use for the information texts. Could you point me/us to it so we can get started? Thanks!

tiborsimko commented 10 years ago

@suenjedt @katilp Thanks for the meeting write-up and further elaboration. It would be useful to turn these notes into a series of independent issues/tasks, so that:

Do you think you could split these into independent issues according to the topic?

As an example, I started independent tasks for VM images, see #47 and #48.

tiborsimko commented 10 years ago

you mentioned this easy editing functionality for html stuff here we could use for the information texts. Could you point me/us to it so we can get started? Thanks!

Here are quick instructions:

Say you'd like to edit "Visualise Events" page that is here:

You'd localise this page in the source code under base/templates directory, either by direct browsing of that place, or by searching for strings that occur on the web page, which will bring you here:

Now you click on Edit icon on the rhs which will open a basic file editor on GitHub. The editor will permit you to edit the page source (in HTML) say to copy/paste HTML text into the template.

Note that the GitHub editor will help you to edit the HTML, e.g. opening/closure of elements like <ul>...</ul>, but the "preview" button will not show you the page in action in any good format; for this one has to preview the page via the Invenio application. (*)

You save your edits and issue a pull request that we'd check, review, and deploy. (Note that issuing a pull request assumes that you first forked this repository in your own space; just use "Fork" button in the top right.)

See also various GitHub guides like:

(*) Otherwise it may be easier to edit page body in some easy-to-use markup format, such as reStructuredText, which would contain a simple preview. However for this we'd have to change the layout of the templates in the repository. Perhaps you can give current HTML-only version a try and see if it is OK with you?

katilp commented 10 years ago

This requires that the page exits: we would need the following areas then, for the sake of clarity I will make a separate issue with the list of pages that we think we need urgently

tiborsimko commented 10 years ago

This requires that the page exits: we would need the following areas then, for the sake of clarity I will make a separate issue with the list of pages that we think we need urgently

Yes, thanks. In order for them to appear on the site, we'd need to create corresponding templates and add some "glue" to the system. Basically the pages will all appear flattened here:

suenjedt commented 10 years ago

OK - Will do tomorrow hopefully. Sorry for our absence today - Proposal submission tomorrow.


From: Tibor Simko [notifications@github.com] Sent: 01 September 2014 15:46 To: tiborsimko/open-data.cern.ch Cc: Sunje Dallmeier-Tiessen Subject: Re: [open-data.cern.ch] Meeting August 28th (#41)

@suenjedthttps://github.com/suenjedt @katilphttps://github.com/katilp Thanks for the meeting write-up and further elaboration. It would be useful to turn these notes into a series of independent issues/tasks, so that:

Do you think you could split these into independent issues according to the topic?

As an example, I started independent tasks for VM images, see #47https://github.com/tiborsimko/open-data.cern.ch/issues/47 and #48https://github.com/tiborsimko/open-data.cern.ch/issues/48.

— Reply to this email directly or view it on GitHubhttps://github.com/tiborsimko/open-data.cern.ch/issues/41#issuecomment-54060576.

tiborsimko commented 10 years ago

Closing this "meta-topical issue" that had been further individualised into separate topical issues (which were either done or for which we are tracking progress elsewhere).