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

Add module overview documentation #6673

Merged
merged 3 commits into from
Nov 16, 2022

Conversation

jcfr
Copy link
Member

@jcfr jcfr commented Nov 16, 2022

@jcfr jcfr linked an issue Nov 16, 2022 that may be closed by this pull request
@jcfr
Copy link
Member Author

jcfr commented Nov 16, 2022

Similarly to the section historically called Where to start? that was available under each module type on this page, I introduced a Getting Started sub section with a link to the Extension Wizard module and existing Slicer modules.

I am wondering if this is the best place for this information. Should we instead keep that section descriptive n and only reference the extension wizard from developer_guide/extensions.html ?

cc: @lassoan @pieper

@jcfr jcfr force-pushed the add-module-overview-documentation branch from bc3d16d to 29685a2 Compare November 16, 2022 10:23
Docs/developer_guide/module_overview.md Outdated Show resolved Hide resolved
Docs/developer_guide/module_overview.md Outdated Show resolved Hide resolved
Docs/developer_guide/module_overview.md Outdated Show resolved Hide resolved
Docs/developer_guide/module_overview.md Outdated Show resolved Hide resolved
Docs/developer_guide/module_overview.md Outdated Show resolved Hide resolved
Docs/developer_guide/module_overview.md Outdated Show resolved Hide resolved
pieper
pieper previously approved these changes Nov 16, 2022
Copy link
Member

@pieper pieper left a comment

Choose a reason for hiding this comment

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

LGTM 👍

I didn't read too closely, but that will be easier and the links can be checked once the docs are generated.

ebrahimebrahim
ebrahimebrahim previously approved these changes Nov 16, 2022
Copy link
Contributor

@ebrahimebrahim ebrahimebrahim left a comment

Choose a reason for hiding this comment

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

Always nice to see traces of the old wiki removed in favor of the sphinx documentation. Agree that we can just do a final check that the links generally work once the documentation is built. Too lazy to build and check locally :)

@jcfr
Copy link
Member Author

jcfr commented Nov 16, 2022

Too lazy to build and check locally :)

Worth noting that the documentation preview is generated for each pull request and may be reviewed using the following link displayed after expanding the list of checks:

image

@ebrahimebrahim
Copy link
Contributor

Worth noting that the documentation preview is generated for each pull request and may be reviewed using the following link displayed after expanding the list of checks

Oh, nice I was looking for that; just need to "show all checks"

Links seem to work 👍

jcfr and others added 2 commits November 16, 2022 17:41
This commit adds the documentation historically maintained on the Slicer
wiki at https://www.slicer.org/wiki/Documentation/Nightly/Developers/Modules

It revisits the "Specifications", "Getting Started" and "More information"
sections based on content adapted from:

* Slicer4_CLI.ppt slides presented at NA-MIC AHM 2012 and historically available at
  https://www.na-mic.org/wiki/AHM2012-Slicer-Overview-and-Migration#Module_Creation_and_Migration

* SlicerProgramming.pptx available at https://github.com/PerkLab/PerkLabBootcamp

It also removes links to obsolete trainings and simply references the
training portal.

Co-authored-by: Julien Finet <julien.finet@kitware.com>
Co-authored-by: Steve Pieper <pieper@isomics.com>
Co-authored-by: Andras Lasso <lasso@queensu.ca>
Co-authored-by: Ebrahim Ebrahim <ebrahim.ebrahim@kitware.com>
This commit adds the documentation historically maintained on the Slicer
wiki at https://www.slicer.org/wiki/Documentation/Nightly/Developers/Build_system/Remote_Module

For reference, the page content was adapted from
https://itk.org/Wiki/ITK/Policy_and_Procedures_for_Adding_Remote_Modules

Co-authored-by: Steve Pieper <pieper@isomics.com>
@jcfr jcfr dismissed stale reviews from ebrahimebrahim and pieper via 7a4ee2f November 16, 2022 22:41
@jcfr jcfr force-pushed the add-module-overview-documentation branch from 29685a2 to 7a4ee2f Compare November 16, 2022 22:41
@jcfr
Copy link
Member Author

jcfr commented Nov 16, 2022

Thanks @ebrahimebrahim and @pieper for the review.

This pull request has been updated to add the documentation historically maintained on the Slicer wiki at https://www.slicer.org/wiki/Documentation/Nightly/Developers/Modules

It revisits the "Specifications", "Getting Started" and "More information" sections based on content adapted from:

It also removes links to obsolete trainings and simply references the training portal.

@jcfr
Copy link
Member Author

jcfr commented Nov 16, 2022

The discussion also led to the creation of issue #6676 discussing proposal for improving the training portal.

@jcfr jcfr merged commit e6da5a8 into Slicer:main Nov 16, 2022
@jcfr jcfr deleted the add-module-overview-documentation branch November 16, 2022 22:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

Describe modules on readthedocs
3 participants