Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Still need details about how we'll handle versions #78

Closed
Klortho opened this issue May 13, 2015 · 2 comments
Closed

Still need details about how we'll handle versions #78

Klortho opened this issue May 13, 2015 · 2 comments

Comments

@Klortho
Copy link
Member

Klortho commented May 13, 2015

This is really a follow-on to #9.

I wrote up and added a couple of detailed procedures to the workflows wiki page:

  • Detailed procedure for new topics
  • Detailed procedure for releasing new recommendations

Here's a survey of the places where versions show up:

  • In the URL of our schema files. For example, "http://jats4r.org/schema/0.1/jats4r.sch". See JATS4R schema processing instruction
  • In the corresponding location for the generated XSLTs. The validator has to know which version of our schema to use
  • In the bin/process-schematron.sh script, which has to know where to get its input, and where to write its output.
  • Tags in our GitHub repository. This should be the canonical way to identify a version of recommendations/schema. IOW, whatever is in the repository at the commit pointed to by the tag is, by definition, that version.
  • The recommendations pages on our website should have a version number attached to them. Our website should have a complete set of the recommendations at each version, with an easy way of navigating between them, and also a set without a version number in the URL, that corresponds to the "current" or latest version. Question: what to do with a particular page (e.g. math) if it doesn't change at all when a new version of the recs is released?
  • In the validator: it has to be able to read the processing instruction, and select the appropriate XSLT files to run. See Parameterize the version number #51 .

In addition to the "Detailed procedure for releasing new recommendations", I think we also need a way to do a "bug fix" release, where there's a minor change or amendment, that doesn't affect the official version number. We need to make sure these are backward compatible.

@Klortho
Copy link
Member Author

Klortho commented May 13, 2015

I'd like to do a "dry run" of these procedures, and put the changes in place for handling versions, using as a dry run the draft recommendation about the JATS4R schema processing instruction, and related issues (#51 and #52).

@Klortho
Copy link
Member Author

Klortho commented Oct 1, 2015

I moved this to the validator issues list, here, since it's too detailed for most folks to be interested in.

@Klortho Klortho closed this as completed Oct 1, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant