Menu

#126 README in file release area out of date

8.22
done
6
2016-08-09
2014-08-07
No

The README file in the release directory for the Guidelines is out of date ([http://sourceforge.net/projects/epidoc/files/Guidelines/]). It currently points to version 8.16 (we're on 8.19 now) and also contains release-specific informaton and a list of authors of the guidelines that is seriously incomplete.

I think we should change the readme to be generic enough that it applies to any release (is the readme in SVN not enough?), but if we want release-specific information in there, we should have a pathway to creating it, and document it on the [ReleaseProc] page.

Related

Home: ReleaseProc

Discussion

  • Hugh A. Cayless

    Hugh A. Cayless - 2014-08-28

    EDAG agrees (on 8/28/14) that the README should become a fairly simple table of contents that outlines the structure of the release directory and points to relevant items, such as the release notes.

     
  • Tom Elliott

    Tom Elliott - 2014-10-16

    The README in question here is this one (for file download): https://sourceforge.net/projects/epidoc/files/Guidelines/

    Not the README that's in the repos.

     
  • Elli Mylonas

    Elli Mylonas - 2014-10-16

    rewrite to be more generic, add links to the necessary documents like release notes etc.
    Explain how to read release notes.
    Explain that this download is not definitive, so not complete with respect to documentation.

     
  • Elli Mylonas

    Elli Mylonas - 2016-07-19
    • Group: 8.21 --> 8.22
     
  • BODARD Gabriel

    BODARD Gabriel - 2016-08-03

    I have created a readme.md file for each of the three file download areas (Guidelines, Schema and Stylesheets). Should we be keeping these files under version control, or shall we just edit them in the download area?

     
  • BODARD Gabriel

    BODARD Gabriel - 2016-08-03
    • status: accepted --> needs-feedback
     
  • Tom Elliott

    Tom Elliott - 2016-08-03

    My instinct is to get them under version control.

     
  • BODARD Gabriel

    BODARD Gabriel - 2016-08-04

    Then perhaps we should look at the option of also merging them with the READMEs in SVN currently? Seems inefficient to be maintaining two parallel sets for the same resources. Will explore.

     
  • BODARD Gabriel

    BODARD Gabriel - 2016-08-09
    • status: needs-feedback --> done
     
  • BODARD Gabriel

    BODARD Gabriel - 2016-08-09

    We decided neither to version control nor to merge these readmes, but to leave them as static files on the download folder.

     

Log in to post a comment.