[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]
Subject: Re: [sca-j] Filename for POJO testcase PR doc
Robin, Thanks for the pointers and suggestions wrt using directories. The TC has discussed the new file naming guidelines and have decided as to what they would like to do wrt file names. But the TC has never discussed the use of subdirectories. Personally, I think use of directories for a TC like SCA-J TC, which has a lot of deliverables, makes sense. But wrt the problem at hand: I think we have a problem that the file name currently contains two version numbers. This is a result of the fact that the POJO testcase doc, when it was first created, used the same filename template as the other SCA documents. The name of the working draft therefore was: sca-j-pojo-ci-1.1-testcases-wd01.pdf Since this document had never gone to the CD/CSD stage and never "Published", we decided to conform to the new guidelines and change it to: sca-j-pojo-ci-testcases-1.1-wd09.<ext> Since the filename/frontpage matter is now responsibility of the TC admin, we submitted the spec after it passed the TC vote to the TC admin and asked for publication. I, as co-chair, am partly responsible for the resulting messed up file name as I forgot to make it very clear what we expected the filename to be. I also failed to notice the filename when it did get published. In any case, I think we need to look at fixing the filenames to: sca-j-pojo-ci-testcases-1.1-wd09.<ext> and figure out if it is possible to have redirects from the existing URLs that contain both '1.0' and '1.1' version numbers, since these URLs have now been published. Any advice on this is appreciated. Thanks! -Anish -- [1] http://lists.oasis-open.org/archives/sca-j/201011/msg00045.html On 2/2/2011 9:26 AM, Robin Cover wrote: > On Wed, 2 Feb 2011, Mike Edwards wrote: > >> >> Robin, >> >> I appreciate the desire for the use of directories and I am sure we >> can adopt them. >> >> However, I fail to see how directories have anything to do with the >> name of a single file, and >> in particular why this name has been chosen: >> >> sca-j-pojo-ci-1.1-testcases-1.0-csprd01.pdf >> >> - in this case, our concern is the "1.0" that has been added in a >> filename that already contains a "1.1" > > I agree 100% with the concern. While we respect (to some degree) the > concept of opacity in URIs, we (I) also think it's useful for > filenames (in URIs) to be as suggestive and intuitive > as possible. In the case above, I'd guess that someone unfamiliar > with the TC's work would not have much of a clue as to what > "1.1" and "1.0" refer to, as probable versioning/revisioning > identifier components. And I don't know the history of the filename > construction, etc., in this particular case. > > So if there's an inclination to design a fix, I will support > it. > > Today I'm wedged for time, but will add this to my list of > things to investigate. We have other situations (e.g., like > profile specifications written to correspond to a principal > spec like SAML or XACML, where the parent has a version > number (1.0, 1.1, 2.0) and the independent profile as a > Work Product also has a version number (1.0, 1.1)... So > there are general use cases and I think we need a general > solution that makes sense for users. > > - Robin > >> >> - 1.1 in this file concerns a particular level of the specifications - >> adding a "1.0" tag seems to confuse things a lot. >> >> - why is the "1.0" tag required?? >> >> >> Yours, Mike >> >> ____________________________________________________________________________________________________________________________________ >> >> Dr Mike Edwards Mail Point 146, Hursley Park >> [IMAGE] >> STSM Winchester, Hants SO21 2JN >> SCA & Services Standards United Kingdom >> Co-Chair OASIS SCA Assembly TC >> IBM Software Group >> Phone: +44-1962 818014 >> Mobile: +44-7802-467431 (274097) >> e-mail: mike_edwards@uk.ibm.com >> >> >> >> >> >> From: Robin Cover <robin@oasis-open.org> >> To: Anish Karmarkar <Anish.Karmarkar@oracle.com> >> Cc: OASIS Java <sca-j@lists.oasis-open.org> >> Date: 02/02/2011 16:16 >> Subject: Re: [sca-j] Filename for POJO testcase PR doc >> >> ____________________________________________________________________________________________________________________________________ >> >> >> >> >> Anish, >> >> I spotted your message just in passing, about filenames >> and the Naming Directives. >> >> I would encourage you and others on the TC to consider >> making changes to the sca-j publication tree for >> the existing and new specifications so as to conform >> (more) with the Naming Directives. What I'm writing here >> would apply to all OASIS TCs. >> >> Obviously, for work already underway, the naming practices >> should be transitioned carefully so that nothing breaks. >> >> On the other hand, I think there's strong motivation to >> move toward the use of directories rather than storing >> everything the TC produces in one huge directory. Have >> a look please: >> >> http://docs.oasis-open.org/opencsa/sca-j/?D=D >> >> In preparation for publication of the new Naming Directives, >> Staff and TAB did a lot more work to set out rational >> principles for use of directories, so that OASIS TCs don't >> end up with multiple dozens or hundreds of files >> (for different specifications) in one massive directory. >> The earlier Naming Guidelines (2006-2008 vintage) [1] >> also recommended the use of directories (paths) for >> resources, but in the new Naming Directives, the >> rule was made clearer: >> >> http://docs.oasis-open.org/specGuidelines/ndr/namingDirectives.html#paths >> http://docs.oasis-open.org/[tc-shortname]/[WP-abbrev]/[version-id]/[stage-abbrev][revisionNumber]/[doc-id].[ext] >> >> >> The Naming Directives don't recognize all of the issues >> arising from legacy naming practices, or the need for >> reasonable extensions/exceptions to accommodate work >> "parts", and so forth. But the core principles are clear >> I hope: use directories, and in particular, a separate >> directory for each new release (i.e., each publication instance >> or event corresponding to a TC spec approval) per >> "/[stage-abbrev][revisionNumber]/" above csd01, csd02... >> >> It takes some planning to design the use of a directory >> for a Work Product and potentially for parts of >> a Work Product, but the rewards are great for usability >> (end users) and for resource management. Without >> directories, it becomes difficult to manage resources >> through collections of URI aliases. When one uses >> directories (just like I imagine most of us do on >> local computers), it's easy to store everything relating >> to each new release (csd01, csd02, pr01, cds03, pr02, >> cs01, cs02...) in one place. Access and URI management >> are much improved. >> >> Please let me know how I can help you in this goal, with >> respect to the OASIS Library and the new Naming >> Directives. >> >> - Robin >> >> [1] old Naming Guidelines, no longer current >> http://docs.oasis-open.org/specGuidelines/namingGuidelines/metadata.html#specURIs >> >> >> Robin Cover >> Interim TC Administrator >> OASIS, Director of Information Services >> Editor, Cover Pages and XML Daily Newslink >> Email: robin@oasis-open.org >> Staff bio: http://www.oasis-open.org/who/staff.php#cover >> Cover Pages: http://xml.coverpages.org/ >> Newsletter: http://xml.coverpages.org/newsletterArchive.html >> Tel: +1 972-296-1783 >> >> >> On Wed, 2 Feb 2011, Anish Karmarkar wrote: >> >> > I recently noticed that the POJO testcase PR doc is named >> > sca-j-pojo-ci-1.1-testcases-1.0-csprd01.pdf [1] >> > >> > Why is there a "1.0" in there? >> > >> > The syntax for filenames per the naming directives [2] is: >> > [WP-abbrev]-[version-id]-[stage-abbrev][revisionNumber].[ext] >> > >> > The filename should therefore be: >> > sca-j-pojo-ci-testcases-1.1-csprd01.pdf >> > >> > -Anish >> > -- >> > >> > >> > [1] >> > >> http://docs.oasis-open.org/opencsa/sca-j/sca-j-pojo-ci-1.1-testcases-1.0-csprd01.pdf >> >> > [2] http://docs.oasis-open.org/specGuidelines/ndr/namingDirectives.html >> > >> > --------------------------------------------------------------------- >> > To unsubscribe from this mail list, you must leave the OASIS TC that >> > generates this mail. Follow this link to all your TCs in OASIS at: >> > https://www.oasis-open.org/apps/org/workgroup/portal/my_workgroups.php >> > >> >> --------------------------------------------------------------------- >> To unsubscribe from this mail list, you must leave the OASIS TC that >> generates this mail. Follow this link to all your TCs in OASIS at: >> https://www.oasis-open.org/apps/org/workgroup/portal/my_workgroups.php >> >> >> >> >> >> >> ____________________________________________________________________________________________________________________________________ >> >> >> >> Unless stated otherwise above: >> IBM United Kingdom Limited - Registered in England and Wales with >> number 741598. >> Registered office: PO Box 41, North Harbour, Portsmouth, Hampshire PO6 >> 3AU >> >> >> >> >> >> >> >> > > > --------------------------------------------------------------------- > To unsubscribe from this mail list, you must leave the OASIS TC that > generates this mail. Follow this link to all your TCs in OASIS at: > https://www.oasis-open.org/apps/org/workgroup/portal/my_workgroups.php
[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]