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
(→User Guide) |
|||
| Line 16: | Line 16: | ||
* [[Orion/Documentation/User Guide/Tasks/Working with folders and files|Working with folders and files]] | * [[Orion/Documentation/User Guide/Tasks/Working with folders and files|Working with folders and files]] | ||
| − | * [[Orion/Documentation/User Guide/Tasks/Navigating and searching|Navigating and searching]] | + | * [[Orion/Documentation/User Guide/Tasks/Navigating and searching|Navigating and searching]] --Libing |
* [[Orion/Documentation/User Guide/Tasks/Importing|Importing]] | * [[Orion/Documentation/User Guide/Tasks/Importing|Importing]] | ||
* [[Orion/Documentation/User Guide/Tasks/Exporting|Exporting]] | * [[Orion/Documentation/User Guide/Tasks/Exporting|Exporting]] | ||
| − | * [[Orion/Documentation/User Guide/Tasks/Comparing|Comparing]] | + | * [[Orion/Documentation/User Guide/Tasks/Comparing|Comparing]] --Libing |
* [[Orion/Documentation/User Guide/Tasks/Working with Git|Working with Git]] | * [[Orion/Documentation/User Guide/Tasks/Working with Git|Working with Git]] | ||
| Line 27: | Line 27: | ||
* [[Orion/Documentation/User Guide/Reference/Coding page|Coding page]] | * [[Orion/Documentation/User Guide/Reference/Coding page|Coding page]] | ||
* [[Orion/Documentation/User Guide/Reference/Shell page|Shell page]] | * [[Orion/Documentation/User Guide/Reference/Shell page|Shell page]] | ||
| − | * [[Orion/Documentation/User Guide/Reference/Search_Results_page|Search and Replace page]] | + | * [[Orion/Documentation/User Guide/Reference/Search_Results_page|Search and Replace page]] --Libing |
* [[Orion/Documentation/User Guide/Reference/Settings page|Settings page]] | * [[Orion/Documentation/User Guide/Reference/Settings page|Settings page]] | ||
* [[Orion/Documentation/User Guide/Reference/Profile page|Profile page]] | * [[Orion/Documentation/User Guide/Reference/Profile page|Profile page]] | ||
| Line 37: | Line 37: | ||
* [[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]] | * [[Orion/Documentation/User Guide/Reference/Git Commit page|Git Commit page]] | ||
| − | * [[Orion/Documentation/User Guide/Reference/Compare page|Compare page]] | + | * [[Orion/Documentation/User Guide/Reference/Compare page|Compare page]] --Libing |
* [[Orion/Documentation/User Guide/Reference/Review Request page|Review Request page]] | * [[Orion/Documentation/User Guide/Reference/Review Request page|Review Request page]] | ||
* [[Orion/Documentation/User Guide/Reference/Git Credentials Storage|Git Credentials Storage]] | * [[Orion/Documentation/User Guide/Reference/Git Credentials Storage|Git Credentials Storage]] | ||
Revision as of 15:20, 24 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
Tasks Section:
- Working with folders and files
- Navigating and searching --Libing
- Importing
- Exporting
- Comparing --Libing
- Working with Git
Reference Section:
- Login page
- Coding page
- Shell page
- Search and Replace page --Libing
- Settings page
- Profile page
- Operations page
- Sites page
- Edit Site page
- Repositories page
- Git Status page
- Git Log page
- Git Commit page
- Compare page --Libing
- Review Request page
- Git Credentials Storage
- Install on Local Host
Any new pages missing from this list???
Developer Guide
- Browse jsdoc and ensure it looks reasonable
- Simple plugin example