Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Orion/Documentation/Todo3.0"
(→User Guide) |
(→User Guide) |
||
(22 intermediate revisions by the same user not shown) | |||
Line 14: | Line 14: | ||
* [[Orion/Documentation/User Guide/Getting started|Getting started]] | * [[Orion/Documentation/User Guide/Getting started|Getting started]] | ||
+ | ** Working with folders and files -- Mark, DONE | ||
+ | ** Editing code -- Mark, DONE | ||
+ | ** Working with git -- Mark, DONE | ||
+ | ** Launching your project as a website -- Mark, DONE | ||
+ | ** Extending Orion -- Mark, DONE | ||
** [[Orion/Documentation/User Guide/Getting started#Searching|Searching]] -- Libing, done | ** [[Orion/Documentation/User Guide/Getting started#Searching|Searching]] -- Libing, done | ||
Tasks Section: | Tasks Section: | ||
− | * Convert some material from Git pages in reference section into tasks. Goal to get task coverage for at least most basic git tasks (clone a repo, commit a change, fetch/merge). (Susan <-- think this is an old comment) | + | * <del>Convert some material from Git pages in reference section into tasks. Goal to get task coverage for at least most basic git tasks (clone a repo, commit a change, fetch/merge).</del> (Susan <-- think this is an old comment) |
* [[Orion/Documentation/User Guide/Tasks/Working with folders and files|Working with folders and files]] -- Anthony, done | * [[Orion/Documentation/User Guide/Tasks/Working with folders and files|Working with folders and files]] -- Anthony, done | ||
− | * [[Orion/Documentation/User Guide/Tasks/Navigating and searching|Navigating and searching]] | + | * [[Orion/Documentation/User Guide/Tasks/Navigating and searching|Navigating and searching]] -- Libing, done |
− | * [[Orion/Documentation/User Guide/Tasks/Importing|Importing]] | + | * [[Orion/Documentation/User Guide/Tasks/Importing|Importing]] -- Anthony, done |
− | * [[Orion/Documentation/User Guide/Tasks/Exporting|Exporting]] | + | * [[Orion/Documentation/User Guide/Tasks/Exporting|Exporting]] -- Anthony, done |
− | * [[Orion/Documentation/User Guide/Tasks/Comparing|Comparing]] | + | * [[Orion/Documentation/User Guide/Tasks/Comparing|Comparing]] -- Libing, done |
− | * [[Orion/Documentation/User Guide/Tasks/Working with Git|Working with Git]] | + | * [[Orion/Documentation/User Guide/Tasks/Working with Git|Working with Git]] -- Grant, done |
Reference Section: | Reference Section: | ||
Line 31: | Line 36: | ||
* [[Orion/Documentation/User Guide/Reference/Login page|Login page]] -- Anthony, done | * [[Orion/Documentation/User Guide/Reference/Login page|Login page]] -- Anthony, done | ||
* [[Orion/Documentation/User Guide/Reference/Navigator page|Navigator page]] -- Anthony, done | * [[Orion/Documentation/User Guide/Reference/Navigator page|Navigator page]] -- Anthony, done | ||
− | * [[Orion/Documentation/User Guide/Reference/Coding page|Coding page]] -- Simon | + | * [[Orion/Documentation/User Guide/Reference/Coding page|Coding page]] -- Simon, done |
− | * [[Orion/Documentation/User Guide/Reference/Search_Results_page|Search and Replace page]] -- Libing | + | * [[Orion/Documentation/User Guide/Reference/Search_Results_page|Search and Replace page]] -- Libing, done |
− | * [[Orion/Documentation/User Guide/Reference/Settings page|Settings page]] -- Simon | + | * [[Orion/Documentation/User Guide/Reference/Settings page|Settings page]] -- Simon, done |
* [[Orion/Documentation/User Guide/Reference/Profile page|Profile page]] -- Grant, done | * [[Orion/Documentation/User Guide/Reference/Profile page|Profile page]] -- Grant, done | ||
− | * [[Orion/Documentation/User Guide/Reference/Operations page|Operations page]] -- Simon | + | * [[Orion/Documentation/User Guide/Reference/Operations page|Operations page]] -- Simon, done |
− | * [[Orion/Documentation/User Guide/Reference/Sites page|Sites page]] -- Grant | + | * [[Orion/Documentation/User Guide/Reference/Sites page|Sites page]] -- Grant, done |
* [[Orion/Documentation/User Guide/Reference/Edit Site page|Edit Site page]] -- Grant, done | * [[Orion/Documentation/User Guide/Reference/Edit Site page|Edit Site page]] -- Grant, done | ||
− | * [[Orion/Documentation/User Guide/Reference/Repositories page|Repositories page]] | + | * [[Orion/Documentation/User Guide/Reference/Repositories page|Repositories page]] -- Grant, done |
− | * [[Orion/Documentation/User Guide/Reference/Git Status page|Git Status page]] -- Ken | + | * [[Orion/Documentation/User Guide/Reference/Git Status page|Git Status page]] -- Ken, DONE |
* [[Orion/Documentation/User Guide/Reference/Git Log page|Git Log page]] -- Ken, DONE | * [[Orion/Documentation/User Guide/Reference/Git Log page|Git Log page]] -- Ken, DONE | ||
− | * [[Orion/Documentation/User Guide/Reference/Git Commit page|Git Commit page]] | + | * [[Orion/Documentation/User Guide/Reference/Git Commit page|Git Commit page]] -- Ken, DONE |
− | * [[Orion/Documentation/User Guide/Reference/Compare page|Compare page]] -- Libing | + | * [[Orion/Documentation/User Guide/Reference/Compare page|Compare page]] -- Libing, Done |
− | * [[Orion/Documentation/User Guide/Reference/Review Request page|Review Request page]] -- Grant | + | * [[Orion/Documentation/User Guide/Reference/Review Request page|Review Request page]] -- Grant, done |
− | * [[Orion/Documentation/User Guide/Reference/Git Credentials Storage|Git Credentials Storage]] -- Simon | + | * [[Orion/Documentation/User Guide/Reference/Git Credentials Storage|Git Credentials Storage]] -- Simon, done |
* [[Orion/Documentation/User Guide/Reference/Shell page|Shell page]] -- Grant, done | * [[Orion/Documentation/User Guide/Reference/Shell page|Shell page]] -- Grant, done | ||
− | * [[Orion/How_Tos/Install_Orion_on_Localhost|Install on Local Host]] -- Simon | + | * [[Orion/How_Tos/Install_Orion_on_Localhost|Install on Local Host]] -- Simon, done |
Any new pages missing from this list??? | Any new pages missing from this list??? | ||
Line 53: | Line 58: | ||
* Browse jsdoc and ensure it looks reasonable | * Browse jsdoc and ensure it looks reasonable | ||
− | * [[Orion/Documentation/Developer_Guide/Simple_plugin_example|Simple plugin example]] -- Simon | + | * [[Orion/Documentation/Developer_Guide/Simple_plugin_example|Simple plugin example]] -- Simon, done |
== Miscellaneous == | == Miscellaneous == |
Latest revision as of 16:18, 24 June 2013
Overview
This is a starting list of the pages that need to be updated for R3.0. If you are working on a page, please edit this page and put your name as working on it. Then mark it complete when it's done.
For the user guide, we have two main sections:
- Tasks. Each section describes the workflow for a very specific task ("copy a file", "export a directory", "clone a repository", etc). These tasks can be cross-cutting across pages or not specific to any page (e.g., global search can be started from anywhere). The idea is that this section is useful for people who know want they want to do, but don't know what page to use in Orion to do it. It also tends to work well when people google search because they are often searching for something very specific like this.
- Reference. In this section, we have one documentation page for each Orion page. They can provide any specific information about the structure of that page. Don't repeat the tasks content here, but instead add links at the bottom to related tasks that can be done on that page.
Pages to review
Read through the content, verify that information is still correct. Update screenshots where necessary. Keep screen shots as closely cropped as possible to reduce chance of them becoming outdated again. Mention any new features related to that content.
User Guide
- Getting started
- Working with folders and files -- Mark, DONE
- Editing code -- Mark, DONE
- Working with git -- Mark, DONE
- Launching your project as a website -- Mark, DONE
- Extending Orion -- Mark, DONE
- Searching -- Libing, done
Tasks Section:
-
Convert some material from Git pages in reference section into tasks. Goal to get task coverage for at least most basic git tasks (clone a repo, commit a change, fetch/merge).(Susan <-- think this is an old comment) - Working with folders and files -- Anthony, done
- Navigating and searching -- Libing, done
- Importing -- Anthony, done
- Exporting -- Anthony, done
- Comparing -- Libing, done
- Working with Git -- Grant, done
Reference Section:
- Welcome page -- Obsolete page, done
- Login page -- Anthony, done
- Navigator page -- Anthony, done
- Coding page -- Simon, done
- Search and Replace page -- Libing, done
- Settings page -- Simon, done
- Profile page -- Grant, done
- Operations page -- Simon, done
- Sites page -- Grant, done
- Edit Site page -- Grant, done
- Repositories page -- Grant, done
- Git Status page -- Ken, DONE
- Git Log page -- Ken, DONE
- Git Commit page -- Ken, DONE
- Compare page -- Libing, Done
- Review Request page -- Grant, done
- Git Credentials Storage -- Simon, done
- Shell page -- Grant, done
- Install on Local Host -- Simon, done
Any new pages missing from this list???
Developer Guide
- Browse jsdoc and ensure it looks reasonable
- Simple plugin example -- Simon, done