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

Post-release 21 Documentation updates #4995

Closed
14 of 27 tasks
christinerogers opened this issue Aug 1, 2019 · 7 comments
Closed
14 of 27 tasks

Post-release 21 Documentation updates #4995

christinerogers opened this issue Aug 1, 2019 · 7 comments
Labels
Category: Documentation PR or issue that aims to improve the documentation (test plans, wiki, comments...)

Comments

@christinerogers
Copy link
Contributor

christinerogers commented Aug 1, 2019

(non-exhaustive list, in progress)
Needs cross-checking with new Readmes from Wiki-revamp

Things moved under docs/ RaisinBread -> broken links

  • public instruments removed / moved to Raisinbread
  • bmi.linst which used to be under docs/instruments/

  • MRI Parameter form which is required(?) for the upcoming QC Browser (can't load without)

  • requires updating the Behavioural Setup Guide... probably other pages too.

Install process Readme(s):

Reliability module removed : Remove all mentions #4596

Training module removed - Documentation to be updated:

Reactified modules:

Tools scripts moved to a different directory

  • Wiki / wiki-readmes to be updated

CenterID -> Registration Center ID #4078

  • wiki / wiki readmes
  • Module Readmes
  • installers for Loris, Loris-MRI
  • Loris-MRI documentation
  • any scripts? any help text?

Gender renamed to sex

Config Path cleanup: #4314

Double-check the wiki, etc.

UseProjects - remove all mentions killed #4496

@christinerogers christinerogers changed the title Post-release Documentation updates Post-release 21 Documentation updates Aug 5, 2019
@johnsaigle johnsaigle added the Category: Documentation PR or issue that aims to improve the documentation (test plans, wiki, comments...) label Aug 6, 2019
@johnsaigle
Copy link
Contributor

Last point should be addressed by #5433

@johnsaigle
Copy link
Contributor

johnsaigle commented Oct 30, 2019

Training module removed - update Module Readmes:
Examiner module readme : remove mentions of Training module

@sruthymathew123 Would you be able to update this during release testing for v22? Asking because you're assigned to test it.

@johnsaigle
Copy link
Contributor

Gender renamed to sex

All points resolved by #5874 except for GitHub wiki files.

@stale
Copy link

stale bot commented Feb 16, 2020

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the State: Stale PR that has had no recent activity, needs to be triaged for review or closure to proceed label Feb 16, 2020
@stale
Copy link

stale bot commented Feb 17, 2020

The Stale label is being removed automatically because some activity has occurred or because the developers have decided that this pull request is important and should not continue to be overlooked.

@stale stale bot removed the State: Stale PR that has had no recent activity, needs to be triaged for review or closure to proceed label Feb 17, 2020
@johnsaigle
Copy link
Contributor

@christinerogers I think this is resolved except for the RegistrationCenterID references in the (deprecated) wiki.

Are you in favour of closing this and creating a separate ticket for this final update?

@johnsaigle
Copy link
Contributor

I'm going to close this for now. The remaining items exist in the GitHub Wiki which is in the process of being deprecated. As we rewrite these pages for the new ReadTheDocs wiki we should be able to catch outdated sections during code review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Category: Documentation PR or issue that aims to improve the documentation (test plans, wiki, comments...)
Projects
None yet
Development

No branches or pull requests

2 participants