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/Todo"
< Orion | Documentation
(→User Guide) |
(→User Guide) |
||
Line 36: | Line 36: | ||
* [[Orion/Documentation/User Guide/Reference/Git Status page|Git Status page]] | * [[Orion/Documentation/User Guide/Reference/Git Status page|Git Status page]] | ||
* [[Orion/Documentation/User Guide/Reference/Git Log page|Git Log page]] | * [[Orion/Documentation/User Guide/Reference/Git Log page|Git Log page]] | ||
− | * [[Orion/Documentation/User Guide/Reference/Git Commit page|Git Commit page]] --Curtis | + | * <del>[[Orion/Documentation/User Guide/Reference/Git Commit page|Git Commit page]] --Curtis</del> |
* <del>[[Orion/Documentation/User Guide/Reference/Compare page|Compare page]] --Libing</del> | * <del>[[Orion/Documentation/User Guide/Reference/Compare page|Compare page]] --Libing</del> | ||
* [[Orion/Documentation/User Guide/Reference/Review Request page|Review Request page]] | * [[Orion/Documentation/User Guide/Reference/Review Request page|Review Request page]] |
Revision as of 15:30, 29 October 2013
Overview
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 Section, Libing)
Tasks Section:
-
Working with folders and files --Grant -
Navigating and searching --Libing -
Importing --Grant -
Exporting --Grant -
Comparing --Libing - Working with Git
Reference Section:
-
Login page --Grant - Editing page
-
Shell page --Grant -
Search and Replace page --Libing -
Settings page --Grant -
Profile page --Grant -
Operations page --Grant -
Sites page --Grant -
Edit Site page --Grant -
Repositories page --Curtis - Git Status page
- Git Log page
-
Git Commit page --Curtis -
Compare page --Libing - Review Request page
- Git Credentials Storage -- Maciek
- Install on Local Host
Any new pages missing from this list???
Developer Guide
- Browse jsdoc and ensure it looks reasonable
-
Simple plugin example - Mark -
Orion/Documentation/Developer_Guide/Architecture - Mark -
Orion/Documentation/Developer_Guide/Plugging_into_the_navigator - Mark -
Orion/Documentation/Developer_Guide/Plugging_into_the_editor - Mark - Orion/Server_admin_guide