cernopendata / opendata.cern.ch

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

articles: titles and slugs #1753

Closed tiborsimko closed 6 years ago

tiborsimko commented 6 years ago

As discussed in various PRs such as #1601 and #1749, it would be useful to have a complete list of all "articles" we plan to display with their wanted titles and slugs, so that we can organise the source code accordingly.

For example:

page idea old URL new URL (/articles/slug) page title
VMs for ALICE /VM/ALICE /articles/virtual-machines-alice ALICE Virtual Machines: How to install
CMS open data research-oriented guide written by Achim - /articles/cms-guide-for-research CMS Guide to research use of CMS Open Data
... ... ... ...

Such a complete table will help with finding nice names for "CMS troubleshooting" etc.

Note that currently, slug is derived from title, while in the future, it should be settable in the JSON, so that the last part of "new URL" will be different (=shorter) from the full title. IOW, we shall treat slug as a doi, or as a recid, of sorts... This will also permit us to change titles without changing URLs. (We had cases of this happening in the past...)

@daslerr @sefeg Would you like to take a stab at drafting such as Slug vs Title map for all the articles? You could take the list of all available COD2 pages for a start: https://github.com/cernopendata/opendata.cern.ch/issues/1228#issuecomment-292994773

sefeg commented 6 years ago

This combines COD2 pages and the articles discussed in #1732 (those that are ready). Everyone can directly edit this table.

page idea old URL new URL (/articles/slug) page title
VMs for ALICE /VM/ALICE /documentation/alice-virtual-machines ALICE Virtual Machines: How to install
VMs for CMS /VM/CMS /documentation/cms-virtual-machines-<year> CMS <year> Virtual Machines: How to install
VMs for LHCb /VM/LHCb /documentation/lhcb-virtual-machines LHCb Virtual Machines: How to install
VM validation report for CMS /VM/CMS/validation/report /documentation/cms-virtual-machines-validation Testing the CernVM
CMS Physics Objects /about/CMS-Physics-Objects /documentation/cms-physics-objects-<year> CMS Physics Objects <year>
CMS Pile-up Simulation /about/CMS-Pileup-Simulation /documentation/cms-pileup-simulation CMS Pile-up Simulation
CMS Simulated Dataset Names /about/CMS-Simulated-Dataset-Names /documentation/cms-simulated-dataset-names CMS Simulated Dataset Names
Getting started with <year> CMS data /getting-started/CMS/<year> /documentation/cms-getting-started-<year> Getting started with CMS <year> data
Getting started with ALICE resources /getting-started/ALICE /documentation/alice-getting-started Learn how to use the ALICE virtual machine to have a first look at ALICE events and use analysis tools
Getting started with LHCb resources /getting-started/LHCb /documentation/lhcb-getting-started Learn how to use the LHCb virtual machine to have a first look at LHCb events and use analysis tools
CMS open data research-oriented guide written by Achim - /documentation/cms-guide-for-research Guide to research use of CMS Open Data
CMS open data education-oriented guide written by Achim - /documentation/cms-guide-for-education Guide to education use of CMS Open Data
News article to inform about COD3 portal update - /documentation/portal-update-2017 Welcome to our updated portal
Report from 2017 summer students - /documentation/cms-summer-student-report-2017 Improving educational content with high school teachers: A summer student report
CMS Troubleshooting guide - /documentation/cms-troubleshooting CMS Response to errors
tiborsimko commented 6 years ago

@sefeg Thanks!

Regarding getting-started-<year>-cms, I think it's better to have the order <topic>-<exp>-<year> rather than <topic>-<year>-<exp>, because some experiments don't have year..

Moreover, since we also have cms-physics-objects-<year>, perhaps we should standardise upon the following scheme:

which would give:

I think this would give a nicely consistent naming everywhere?

sefeg commented 6 years ago

Agreed! I updated the table accordingly