Notice: this Wiki will be going read only early in 2024 and edits will no longer be 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
m (→Overview) |
(→User Guide: link to pages) |
||
| Line 11: | Line 11: | ||
== [[Orion/Documentation/User_Guide|User Guide]] == | == [[Orion/Documentation/User_Guide|User Guide]] == | ||
| − | * Getting | + | * [[Orion/Documentation/User Guide/Getting started|Getting started]] |
Tasks Section: | Tasks Section: | ||
| Line 19: | Line 19: | ||
Reference Section: | Reference Section: | ||
| − | * Welcome page | + | * [[Orion/Documentation/User Guide/Reference/Welcome page|Welcome page]] |
| − | * Login page | + | * [[Orion/Documentation/User Guide/Reference/Login page|Login page]] |
| − | * Navigator page (John) | + | * [[Orion/Documentation/User Guide/Reference/Navigator page|Navigator page]] (John) |
| − | * Coding page | + | * [[Orion/Documentation/User Guide/Reference/Coding page|Coding page]] |
| − | * Search and Replace page | + | * [[Orion/Documentation/User Guide/Reference/Search_Results_page|Search and Replace page]] |
| − | * Settings page | + | * [[Orion/Documentation/User Guide/Reference/Settings page|Settings page]] |
| − | * Profile page | + | * [[Orion/Documentation/User Guide/Reference/Profile page|Profile page]] |
| − | * Operations page | + | * [[Orion/Documentation/User Guide/Reference/Operations page|Operations page]] |
| − | * Site Configurations page | + | * [[Orion/Documentation/User Guide/Reference/Site Configurations page|Site Configurations page]] |
| − | * Edit Site page | + | * [[Orion/Documentation/User Guide/Reference/Edit Site page|Edit Site page]] |
| − | * Repositories page | + | * [[Orion/Documentation/User Guide/Reference/Repositories page|Repositories page]] |
| − | * Git Status page | + | * [[Orion/Documentation/User Guide/Reference/Git Status page|Git Status page]] |
| − | * Git Log page | + | * [[Orion/Documentation/User Guide/Reference/Git Log page|Git Log page]] |
| − | * Git Commit page | + | * [[Orion/Documentation/User Guide/Reference/Git Commit page|Git Commit page]] |
| − | * Compare page | + | * [[Orion/Documentation/User Guide/Reference/Compare page|Compare page]] |
| − | * Review Request page | + | * [[Orion/Documentation/User Guide/Reference/Review Request page|Review Request page]] |
| − | * Git Credentials Storage | + | * [[Orion/Documentation/User Guide/Reference/Git Credentials Storage|Git Credentials Storage]] |
Any new pages missing from this list??? | Any new pages missing from this list??? | ||
Revision as of 10:51, 15 October 2012
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
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).
Reference Section:
- Welcome page
- Login page
- Navigator page (John)
- Coding page
- Search and Replace page
- Settings page
- Profile page
- Operations page
- Site Configurations page
- Edit Site page
- Repositories page
- Git Status page
- Git Log page
- Git Commit page
- Compare page
- Review Request page
- Git Credentials Storage
Any new pages missing from this list???
Developer Guide
- Browse jsdoc and ensure it looks reasonable
- Simple plugin example