User Story #6381 (new)
Opened 13 years ago
Last modified 8 years ago
Unify all example snippets
Reported by: | jamoore | Owned by: | |
---|---|---|---|
Priority: | minor | Milestone: | GatherReqs |
Component: | Documentation | Keywords: | n.a. |
Cc: | szwells, wmoore | Story Points: | n.a. |
Sprint: | n.a. | Importance: | n.a. |
Total Remaining Time: | n.a. | Estimated Remaining Time: | n.a. |
Description (last modified by wmoore)
We have examples hard-coded in wiki pages, examples in git under examples/, examples on the forums. It would be useful if all our examples were somehow organized, (indexed?), and more manageable.
We also have test code and working code that can be referenced. E.g. gateway.init.py, Insight gateway.java etc. have tons of examples.
Any ideas?
- Do we want this code under git?
- Do we want to be able to tag each example? E.g. "rawPixelsStore", "Python", "create image"
- How to do that? Not supported in forums? wiki?
Options:
- Keep code in it's "home" location (/examples, forum, wiki pages etc) and link from a central examples "site map"
- Take all "example" code (not tests etc) and put it under /examples. Just have a wiki page that points to the root directories and put all the docs that are needed in the code itself
- Policy for providing code in forums: put it somewhere else first and put link/paste code in forums?
- ?!?!?!? other ideas?
Need to discuss!
Change History (5)
comment:1 Changed 13 years ago by wmoore
- Description modified (diff)
comment:2 Changed 13 years ago by jburel
comment:3 Changed 13 years ago by jmoore
- Milestone changed from OMERO-Beta4.3.2 to OME-5.0
comment:4 Changed 12 years ago by jmoore
- Component changed from General to Documentation
- Milestone changed from OMERO-Beta4.4 to OMERO-Beta4.4.x
comment:5 Changed 8 years ago by jamoore
- Milestone changed from 5.x to GatherReqs
Training material has been added to examples/Training, we cover
Same standard examples
You can check it out from git@…:will-moore/openmicroscopy.git