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 "EPF Wiki User Guide"
m (→Setup and Configuration) |
m (→Creating and Updating Wikis) |
||
| Line 26: | Line 26: | ||
You can create a Baseline Process from a server folder that contains a EPFC published site or you can upload a zip file containing a EPFC published site. It is recommended to upload your sites using FTP or SCP to the server folder and not use the upload functionality of the EPF Wiki web site because this puts a considerable load on the web server. | You can create a Baseline Process from a server folder that contains a EPFC published site or you can upload a zip file containing a EPFC published site. It is recommended to upload your sites using FTP or SCP to the server folder and not use the upload functionality of the EPF Wiki web site because this puts a considerable load on the web server. | ||
| − | IMPORTANT NOTE: make sure that a server folder or zip file does not contain sub folders. Or, put differently, make sure that index.htm is in the root of the folder you upload using FTP or SCP or is in the root of the zip file you upload. | + | IMPORTANT NOTE: make sure that a server folder or zip file does not contain sub folders. Or, put differently, make sure that '''index.htm''' is in the root of the folder you upload using FTP or SCP or is in the root of the zip file you upload. |
| + | |||
| + | Using technical abbreviations with version information for your Baseline Processes will make managing sites easier. Use for example OUP_1.0_RC4_20070725 for the file name of the zip file or folder name for OpenUP 1.0 release candidate 4 with build id 20070725. | ||
| + | |||
| + | Create a Wiki with '''Manage > Sites > New Wiki'''. | ||
| + | |||
| + | The folder name will be part of URL so it is recommended to use abbrevations without special characters. For example '''oup''' for a Wiki for OpenUP. | ||
| + | |||
| + | This will create a empty Wiki site. You now can create a job to update the Wiki with a Baseline Process. Select Manage > Sites > <name of the Wiki>. This will display information on that Wiki. Select the link 'Select a Baseline Process' and press '''Ok'''. | ||
== Updating a Wiki == | == Updating a Wiki == | ||
Revision as of 10:08, 8 July 2008
If you have any questions about this guide or EPF Wiki please use the Eclipse Process Framework Project Developers List
Information on installing EPF Wiki is in EPF Wiki Installation Guide
Contents
Setup and Configuration
After you install EPF Wiki and you have started your Web server, you can access EPF Wiki using your Internet Browser. EPF Wiki will display a form where you can create the first, main administrator account.
The creation of this account, will also create a Wiki called 'Templates' which purpose is to provide templates for creating new pages to other Wikis. This special Wiki is not accessisble from the home page but you can find in the list of Wikis by selecting Manage from the home page.
A number of texts in EPF Wiki can be changed, you problably want to change them directly after creating the first account.
From the home page select Manage and then click your email adress displayed on the right side of the toolbar. This will display your account details and will present links to the texts you can change:
- Welcome
- About
- Login
- Help
- Terms of Use
- Privacy Policy
If you do not want a Terms of Use of Privacy Policy for your site you can clear those texts. This will also remove the links in the footer to these pages.
Creating and Updating Wikis
Wikis are created and updated using Baseline Processes. A Baseline Process is just a EPFC published site. To create one, select Manage > Sites > New Baseline Process.
You can create a Baseline Process from a server folder that contains a EPFC published site or you can upload a zip file containing a EPFC published site. It is recommended to upload your sites using FTP or SCP to the server folder and not use the upload functionality of the EPF Wiki web site because this puts a considerable load on the web server.
IMPORTANT NOTE: make sure that a server folder or zip file does not contain sub folders. Or, put differently, make sure that index.htm is in the root of the folder you upload using FTP or SCP or is in the root of the zip file you upload.
Using technical abbreviations with version information for your Baseline Processes will make managing sites easier. Use for example OUP_1.0_RC4_20070725 for the file name of the zip file or folder name for OpenUP 1.0 release candidate 4 with build id 20070725.
Create a Wiki with Manage > Sites > New Wiki.
The folder name will be part of URL so it is recommended to use abbrevations without special characters. For example oup for a Wiki for OpenUP.
This will create a empty Wiki site. You now can create a job to update the Wiki with a Baseline Process. Select Manage > Sites > <name of the Wiki>. This will display information on that Wiki. Select the link 'Select a Baseline Process' and press Ok.