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

Reorganization of folder structure #295

Open
martindholmes opened this issue Apr 18, 2024 · 2 comments
Open

Reorganization of folder structure #295

martindholmes opened this issue Apr 18, 2024 · 2 comments
Labels
enhancement New feature or request release-blocker The dev branch must not be merged into master while a release-blocker bug is open.
Milestone

Comments

@martindholmes
Copy link
Collaborator

@joeytakeda and I decided today that we should reorganize some content as follows:

  1. Create a resources folder in the root.
  2. Move the stemmers folder into it.
  3. Create a subfolder resources/lex, and put the English and French dictionary and stopwords files in there.

When files are moved, we should also add to the ODD file What's New in 2.0 section (which doesn't yet exist), and add to the v1-to-v2 conversion XSLT.

Ideas for further reorganization can be added to this ticket.

@martindholmes martindholmes added enhancement New feature or request release-blocker The dev branch must not be merged into master while a release-blocker bug is open. labels Apr 18, 2024
@martindholmes martindholmes added this to the Release 2.0 milestone Apr 18, 2024
@martindholmes martindholmes modified the milestones: Release 2.0, Blue sky May 10, 2024
@martindholmes
Copy link
Collaborator Author

Quick question to @joeytakeda : We already have a What's New section in the documentation, and it has a section "Changes in version 2.0", which is where we should enumerate all the key changes. But the overall section is called "What's new since version 1.0", which I think we should retitle to just "What's new since version 1", and remove all the existing change records for versions in the 1.x line. The documentation for the 1.4 release branch does properly enumerate that set of changes, but I think for anyone moving from version 1 to 2, we should just document any differences between the last 1.4.x version and the new 2.0. What do you think?

@joeytakeda
Copy link
Contributor

Hmm, I agree that we should retitle it, but I don't think we should remove the old change records (I think it could be useful especially if people are moving from an older version to a newer one or trying to debug something, plus I don't see much harm in keeping it)

What about doing what Saxon does and titling the section: "Change History". So something like:

  • Change History
    • Version 2.0.0
    • Version 1.4.7
    • Version 1.4.6
    • ...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request release-blocker The dev branch must not be merged into master while a release-blocker bug is open.
Projects
None yet
Development

No branches or pull requests

2 participants