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

Update configuration module README to follow imaging_browser template #3374

Merged
merged 3 commits into from
Jan 31, 2018

Conversation

driusan
Copy link
Collaborator

@driusan driusan commented Jan 3, 2018

This updates the configuration module readme.md to follow the template
for module specifications set by the imaging_browser README. (It also
renames the file to README.md to be more consistent.)

The "How to use this module" part of the existing readmd was moved unmodified to
markdown help content, while the "How to upgrade from config.xml"
which was relevant for the LORIS 14.12 release was removed as it's
no longer relevant.

This updates the configuration module readme.md to follow the template
for module specifications set by the imaging_browser README. (It also
renames the file to README.md to be more consistent.)

The "How to use this module" part of the existing readmd was moved to
markdown help content, while the "How to upgrade from config.xml"
which was relevant for the LORIS 14.12 release was removed as it's
no longer relevant.
@driusan driusan added Category: Documentation PR or issue that aims to improve the documentation (test plans, wiki, comments...) [branch] minor labels Jan 3, 2018
@driusan driusan requested a review from taracampbell January 3, 2018 21:09
Copy link
Contributor

@PapillonMcGill PapillonMcGill left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

need clarification

changes. You must press the submit button that is on the page where
you are making the changes for the changes to be stored in the
database. If you press the submit button on another configuration
page, it will not store any changes made on other pages.
Copy link
Contributor

@PapillonMcGill PapillonMcGill Jan 25, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The 2 last lines are not clear. Are we talking about change made this page, another page or other page.

What about:
Pressing the submit button on a page will not save change made on other pages.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks.. I didn't write the content, I just copied it from the old README, but I agree that your wording is more clear, so I updated it.

@driusan driusan dismissed PapillonMcGill’s stale review January 31, 2018 19:09

I don't know why sometimes reviews get autodismissed and sometimes they don't, but these changes are done..

@driusan driusan merged commit 4265c70 into aces:minor Jan 31, 2018
@ridz1208 ridz1208 added this to the PRE 20.0.0 milestone Sep 23, 2018
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

Successfully merging this pull request may close these issues.

3 participants