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"
< Orion | Documentation
(→User Guide) |
(→User Guide) |
||
Line 41: | Line 41: | ||
* [[Orion/Documentation/User Guide/Reference/Git Status page|Git Status page]] -- Ken, DONE | * [[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]] -- Ken | + | * [[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 | ||
* [[Orion/Documentation/User Guide/Reference/Review Request page|Review Request page]] -- Grant | * [[Orion/Documentation/User Guide/Reference/Review Request page|Review Request page]] -- Grant |
Revision as of 16:48, 19 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
- 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
- Importing -- Anthony, done
- Exporting -- Anthony, done
- Comparing
- Working with Git
Reference Section:
- Welcome page -- Obsolete page, done
- Login page -- Anthony, done
- Navigator page -- Anthony, done
- Coding page -- Simon
- Search and Replace page -- Libing
- Settings page -- Simon
- Profile page -- Grant, done
- Operations page -- Simon
- Sites page -- Grant, no changes required, done
- Edit Site page -- Grant, done
- Repositories page
- Git Status page -- Ken, DONE
- Git Log page -- Ken, DONE
- Git Commit page -- Ken, DONE
- Compare page -- Libing
- Review Request page -- Grant
- Git Credentials Storage -- Simon
- Shell page -- Grant, done
- Install on Local Host -- Simon
Any new pages missing from this list???
Developer Guide
- Browse jsdoc and ensure it looks reasonable
- Simple plugin example -- Simon