View Issue Details
ID | Project | Category | View Status | Date Submitted | Last Update |
---|---|---|---|---|---|
0001989 | Slicer4 | Core: Extensions | public | 2012-05-04 14:38 | 2012-07-27 15:21 |
Reporter | jcfr | Assigned To | jcfr | ||
Priority | normal | Severity | minor | Reproducibility | have not tried |
Status | closed | Resolution | fixed | ||
Product Version | |||||
Target Version | Slicer 4.1.1 | Fixed in Version | Slicer 4.1.1 | ||
Summary | 0001989: Update Extension documentation on wiki | ||||
Description | See http://www.slicer.org/slicerWiki/index.php/Documentation/4.1/Developers/Tutorials/ExtensionWriting | ||||
Tags | No tags attached. | ||||
|
|
Ron> As soon I will have finished to work on documentation. Things will be consolidated and clear for the developer |
|
Make sure to explain that project has to be re-configured after updating the source. See 0002087 for details. |
|
Ron - May 18 2012: Hi, Skullstripper: what slicer extension category is the skull stripper? How will the user know at download time? I would like to use Skullstripper as an example to hash things out. I would propose to default extensions to Cat 3 and ask developers to submit a request addressing the requirements, if they want the extension to be Cat 1 or 2. The Cat 3 text mentions that developers are free to set up their own midas server. Could somebody insert a link to a page that describes how to do that? |
|
Ron - May 18 2012: The ppt about extension writing is from January 2011. This should be replaced by real documentation pages on the wiki. This must happen before the project week. |
|
From Jim - May 21, 2012: There are two stages to developing an Extension. 1) Writing the initial Extension, getting it to configure and compile against Slicer, getting everything working within Slicer. 2) Packaging the Extension to be built by the Nightly builds etc. We need a clear description of how people should do 0000001. I have seen at least 3 approaches taken so far. We should have an official recommendation. Something like: "Separate code repository. Separate build tree. Configured to build against a Slicer build tree." Jim |
|
See http://viewvc.slicer.org/viewvc.cgi/Slicer4?view=revision&revision=20160 |
|
See http://viewvc.slicer.org/viewvc.cgi/Slicer4?view=revision&revision=20164 |
|
See https://github.com/jcfr/ExtensionsIndex/tree/24-ExtensionIndex-add-readme-file |
|
See updated extension index documentation: https://github.com/jcfr/ExtensionsIndex/tree/24-ExtensionIndex-add-readme-file#readme |
|
Looks like the API key that the user needs to specific is the one for the "Default" application. It doesn't look like it can be just "any" of the user's API keys. |
|
Would it help to specify that any one of the API key associated with a given user account will be valid. It's the user role to manage it's key. |
|
Hi Folks, Considering the release 4.1.1 mainly includes tweaks and fixes related to the extensions manager and the associated extensions build system, I believe updating the documentation explaining more clearly what are the steps to create and distribute extensions was key. These past few days, I spent some time working on the wiki documentation. Sections associated to both user and developer documentation have been reviewed, simplified and re-organized. I now believe the extensions documentation has reach a state where it could be useful for both developers and users. The following sections attempt to summarize which part of the documentation have been updated. I invite you to check the pages and reply to this email with your comments. Then, later tonight and tomorrow morning, considering your comments, I will update the documentation and draft the 4.1.1 announcement. Updated pagesAmong the updated pages, we can list the following major ones: Documentation New pagesNew pages have also been created: Documentation/4.1/Developers/StartHere with "New community member checklist" and "Develop a module or an extension" section Easier access to developer tutorialsSection "HowTo" of the developer page have been re-organized, making access to developer tutorials easier and straightforward. See Documentation/4.1/Developers ExtensionsIndex documentation updatedSee https://github.com/jcfr/ExtensionsIndex/tree/24-ExtensionIndex-add-readme-file#readme Based on your comments, text has been updated and a diagram has been added to the page. It illustrates more clearly depicts how extensions catalog, extensions server, CDash and the slicer factory interact. Thanks |
|
Date Modified | Username | Field | Change |
---|---|---|---|
2012-05-04 14:38 | jcfr | New Issue | |
2012-05-04 14:38 | jcfr | Status | new => assigned |
2012-05-04 14:38 | jcfr | Assigned To | => jcfr |
2012-05-08 15:00 | jcfr | Target Version | => Slicer 4.1.1 |
2012-05-14 18:03 | kikinis | Note Added: 0004386 | |
2012-05-18 11:02 | jcfr | Note Added: 0004498 | |
2012-05-18 11:02 | jcfr | Note Added: 0004499 | |
2012-05-18 11:03 | jcfr | Relationship added | related to 0002087 |
2012-05-20 09:11 | jcfr | Note Added: 0004515 | |
2012-05-20 09:12 | jcfr | Note Added: 0004516 | |
2012-05-21 05:40 | jcfr | Note Added: 0004528 | |
2012-05-26 18:35 | jcfr | Note Added: 0004629 | |
2012-05-27 08:29 | jcfr | Note Added: 0004634 | |
2012-05-27 14:19 | jcfr | Note Added: 0004642 | |
2012-06-05 19:07 | jcfr | Note Added: 0004776 | |
2012-06-11 06:10 | millerjv | Note Added: 0004801 | |
2012-06-11 06:22 | jcfr | Note Added: 0004803 | |
2012-06-18 20:40 | jcfr | Note Added: 0004850 | |
2012-06-18 20:40 | jcfr | Status | assigned => resolved |
2012-06-18 20:40 | jcfr | Fixed in Version | => Slicer 4.1.1 |
2012-06-18 20:40 | jcfr | Resolution | open => fixed |
2012-07-27 15:21 | jcfr | Status | resolved => closed |