openEHR web (last?) URI makeover...

Time to start using this list....

Erik Sundvall wrote:

Hi!

I have made some comments regarding URI structure with the intention
to get some debate going, and some discussions have taken place.

This is a last(?) attempt at being of help for a somewhat futureproof
and good-looking URI space for openEHR. The intention is not to be
mean to anybody... Seems like people are pressed by a deadline and
concrete suggestions might then be better than trying to speak in
general terms (Some previous examples and general thoughts seem to
have resulted in getting people annoyed and/or defensive, sorry about
that.) Suggestions below are intended for long lasting URLs and do not
need to change the current menu structure.
  

your comments are excellent. Don't worry if I don't agree with 100% of
them;-) I do think some of the things mentioned on that reference you
gave yesterday are wrong - probably because I am into readability and
parsing, and I just don't think those people have thought that much
about these issues - not going by some of their points anyway.

But we are certainly pressed for time. Have done your /releases idea.
See below for the rest.

http://www.openehr.org/releases/1.0.1/roadmap.html
http://www.openehr.org/releases/1.0.1/openEHR/introducing_openEHR.pdf
http://www.openehr.org/releases/1.0.1/architecture/rm/ehr_im.pdf

I did the same for release 1.0, but not for previous releases (should
we? Doesn't seem that important, but in fact it is easy enough to do).

Projects are likely to remain as an organising form in openEHR so why
not make them a top entry http://www.openehr.org/projects/ resulting
in the following changes:
/specproject/project.html -> /projects/specifications/ (or /projects/spec/)

/clinicalmodelsproject/overview.html -> /projects/clinical-models/ (or
just /projects/clinical)
/openehr/softwareprojects/ -> /projects/software/

Again, having the individual projects at top level in the _menu_ is
probably still a good idea.
  

I've partially done what you say here - I don't think we can do it
completely because we cannot insert a new level of organisation due to
the menu structure; it could be done in some manual way on the server
disk, but we are trying to stay away from manual trickery).

Logically what we want this time round is the overall structure:
- specifcations (project)
- clinical models (project)
- software projects
    - x
    - y
    - z

So we are treating the specifications and clinical models efforts not
just as one of many other projects but as top-level efforts in openEHR,
which I believe is correct. Having made some changes we have URLs like

http://www.openehr.org/openehr/specifications/project.html
http://www.openehr.org/openehr/specifications/releaseplan.html
http://www.openehr.org/releases/1.0.1/roadmap.html (due to the SVN
checkout area I created)

http://www.openehr.org/openehr/clinicalmodels/project.html
http://www.openehr.org/openehr/clinicalmodels/archetypes.html

http://www.openehr.org/openehr/projects/liu.html
http://www.openehr.org/openehr/projects/java.html
http://www.openehr.org/openehr/projects/eiffel.html

These are not exactly what you asked for but I believe are in the spirit
of long-lived URIs.

News, events and announcements are likely to be referred to in press
releases, blogs, mailing lists etc and could benefit from individual
categories (a top category/directory probably won't be of much help in
URI-space). This could result in the following changes:

/news_events/announcements/ -> /announcements/ (or /announce/)
/news_events/events.html -> /events/
/news_events/news.html -> /news/
  

Agree with the idea...Anthony says he could do that as Apache rewrites,
but it reduces the efficiency of processing URLs - I think we need a
better way of achieving this - doesn't look as if it will happen today.
Hopefully that won't matter.

--- Before launch of the new site you can stop reading here, and
continue when things calm down after launch. ---

Later (not now since I guess that deadline is pressing for some
reason) individual news items could be given sensible permalinks
available under /news/ One way of doing it is common in the blog and
press-release world e.g.
http://googleblog.blogspot.com/2007/10/its-not-about-spam.html
I guess that means aliasing things like
http://www.openehr.org:8888/openehr/198-OE.html
to something like /news/2007/10/Vivici-launch-PHR
I repeat - no hurry - this individual aliasing can be added _after_ launch.
The names given to individual _announcements_ actually already now
follows a similar permalink style, e.g.
http://www.openehr.org:8888/openehr/news_events/announcements/oct2007.htm
  

not sure how we achieve this, but I agree with the idea. I don't think
Apache rewrites are the way - we have to minimise the rewrite rules, not
add to them.

Is there any plan (or foreseeable need) to add very much more than the
current two pages under /getting_involved/ otherwise one could just as
well place them somewhere else e.g.
as html-pages directly under the root, or putting the sponsorship.html
under /about/ if it is intended to list sponsors in the future. On the
other hand these /getting_involved/ URIs might be less important to
change if they are primarily intended as navigational help on the
website and not as likely to be linked to directly from the 'outside'
as the projects, specs and news etc are.
  

I moved the 'contacts' stuff to the 'Getting started' page (link from
home page and in Resources); I moved the Sponshorship page (which we
expect to grow with more content) to the 'About' menu group.

I think this is not a bad starting point....

- thomas