Bug 346299 - [client] doc for editor examples, better dir structure
Summary: [client] doc for editor examples, better dir structure
Status: RESOLVED WONTFIX
Alias: None
Product: Orion (Archived)
Classification: ECD
Component: Editor (show other bugs)
Version: 0.2   Edit
Hardware: PC Windows 7
: P3 normal (vote)
Target Milestone: ---   Edit
Assignee: Project Inbox CLA
QA Contact:
URL:
Whiteboard:
Keywords: Documentation
Depends on:
Blocks:
 
Reported: 2011-05-18 12:49 EDT by Susan McCourt CLA
Modified: 2015-05-05 14:53 EDT (History)
3 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Susan McCourt CLA 2011-05-18 12:49:55 EDT
currently "minimaleditor.html" and "embeddededitor.html" are in the same directory, and there's no clear doc to show you which one you care about.  It would probably be better to do something like:

examples/
  minimaleditor/
    readme.txt
    minimaleditor.html
    minimaleditor.js
  embeddededitor/
    readme.txt
    embeddededitor.html
    embeddededitor.js

etc...
we could include a short description of the example in the readme as well as other info such as how to set up a hosted site of the example, required files, etc.
Comment 1 Susan McCourt CLA 2011-05-18 12:52:09 EDT
I'm assigning this to me for purposes of writing the editor example doc, but cc'ing John for thoughts on dir structure, etc.  We have examples in other places, too.  Do we want to gather them up and present a common format for summary info, etc.?

At first I thought an HTML page that describes the example, links to the example itself, etc.  Then I wondered if having the doc as HTML would confuse from having just one HTML page which *is* the example (hence the suggestion above to do a readme.txt)
Comment 2 Susan McCourt CLA 2011-06-08 21:45:51 EDT
moving doc bugs to RC2
Comment 3 Susan McCourt CLA 2011-06-16 22:46:37 EDT
We achieved the better dir structure when we did the editor reorg.
I unfortunately did not get a chance to improve this doc for 0.2
Comment 4 John Arthorne CLA 2015-05-05 14:53:49 EDT
Closing as part of a mass clean up of inactive bugs. Please reopen if this problem still occurs or is relevant to you. For more details see:

https://dev.eclipse.org/mhonarc/lists/orion-dev/msg03444.html