Skip to content

Commit 03ab4f1

Browse files
committed
PCHR-3811: Documentation updates
- Remove outdated docs that were referring to deprecated and unused URLs and methods - Update the INSTALL.md doc - Update README.md
1 parent 0e51883 commit 03ab4f1

5 files changed

Lines changed: 12 additions & 211 deletions

File tree

README.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,9 @@
1-
CiviHR is a collection of extensions defining a human-resources application
2-
that runs on top of the CiviCRM platform.
1+
[CiviHR](https://civihr.org/) is an open source HR software solution, that runs on top of the CiviCRM platform.
32

43
See also:
54
* Install: [doc/INSTALL.md](doc/INSTALL.md)
6-
* Upgrade: [doc/UPGRADE.md](doc/UPGRADE.md)
7-
* Develop (install, test, etc): [doc/DEVELOP.md](doc/DEVELOP.md)
8-
* Wiki: http://wiki.civicrm.org/confluence/display/HR/CiviHR
9-
* Issues: http://issues.civicrm.org/jira/secure/Dashboard.jspa?selectPageId=11213
5+
* User Guide: http://civihr-documentation.readthedocs.io/en/latest/
6+
* Demo site: https://demo.civihrhosting.co.uk/
107

118
We are using browserstack for testing:
129

doc/DEVELOP.md

Lines changed: 0 additions & 106 deletions
This file was deleted.

doc/INSTALL.md

Lines changed: 9 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -1,74 +1,19 @@
1-
## Pre-requisites
1+
# Introduction
22

3-
CiviCRM 4.5
3+
CiviHR is a complex system, with many moving parts. The code in this repository is just one of these parts. It's possible to create a new site manually, but, given the number of necessary steps, this a hard and time consuming task. For this reason, the best way to install CiviHR is by using one of the installation methods available:
44

5-
> NOTE: CiviHR includes some significant changes to the nomal CiviCRM
6-
> user-experience. As with any significant change or addition, CiviHR
7-
> should be evaluated on a test/staging site before installing on a
8-
> live/production site.
5+
## Using the civihr-installer script
96

10-
## Download
7+
The [civihr-installer](https://github.com/compucorp/civihr-installer) script has a mininum set of requirements and it is a quick way to get CiviHR up and running. Please check its repository for more information on how to use it.
118

12-
```bash
13-
cd </path/to/extension/dir>
14-
# (ex: $drupalroot/vendor/civicrm or $civiroot/tools/extensions or a custom-configed path)
9+
> Note: A site created with this script is not suited for development, as it will not include many tools and files required for this kind of work. If you're looking for that, the installation with buildkit is the way to go.
1510
16-
wget https://github.com/civicrm/civihr/archive/1.4.0.zip
17-
unzip 1.4.0.zip
18-
mv civihr-1.4.0 civihr
19-
```
20-
21-
> NOTE: On some misconfigured systems, the "wget" command may display a warning
22-
> like "ERROR: The certificate of `github.com' is not trusted." For a workaround,
23-
> add the option "--no-check-certificate" or check out [this article](http://blog.55minutes.com/2012/01/fixing-https-certificate-errors-in-wget-and-ruby/).
24-
25-
## Install (Option A: Drush)
11+
## Using buildkit
2612

27-
If you have Drush installed, then you can enable all the extensions at once:
13+
[Buildkit](https://github.com/civicrm/civicrm-buildkit) is a collection of development tools for CiviCRM. Among these tools, there's `civibuild`, which can be used to quickly create new sites. To create a new CiviHR site, you can use the `hr17` build type:
2814

29-
```bash
30-
cd /var/www/drupal
31-
bash vendor/civicrm/civihr/bin/drush-install.sh --with-sample-data
3215
```
33-
34-
If you're familiar with different ways to call drush, then you can use the same
35-
techniques with drush-install.sh, e.g.
36-
37-
```bash
38-
cd /var/www/drupal/vendor/civicrm/civihr
39-
./bin/drush-install.sh --with-sample-data --root=/var/www/drupal
40-
41-
or
42-
43-
cd /var/www/drupal/sites/example.com
44-
bash /var/www/drupal/vendor/civicrm/civihr/bin/drush-install.sh --with-sample-data
16+
$ civibuild create hr17
4517
```
4618

47-
Read the drush-install.sh for details.
48-
49-
## Install (Option B: Manual)
50-
51-
CiviHR includes over a dozen extensions. These can be activated piecemeal.
52-
The following extensions provide the major features and may be activated
53-
individually:
54-
55-
* org.civicrm.hrbank: Bank Details
56-
* org.civicrm.hrcareer: Career History
57-
* org.civicrm.hrdemog: Extended Demographics
58-
* org.civicrm.hremerg: Emergency Contacts
59-
* org.civicrm.hrabsence: Absences
60-
* org.civicrm.hrjobcontract: Job Contracts
61-
* org.civicrm.hrmed: Medical and Disability
62-
* org.civicrm.hrqual: Qualifications
63-
* org.civicrm.hrreport: Reporting
64-
* org.civicrm.hrstaffdir: Staff Directory
65-
* org.civicrm.hrcase: Case
66-
* org.civicrm.hrcaseutils: Case Utils
67-
* org.civicrm.hrim: Instant messanger link
68-
* org.civicrm.hrrecruitment: Recruitment
69-
* org.civicrm.hrprofile: Profile
70-
71-
Finally, these two extensions build on top of the others:
72-
73-
* uk.co.compucorp.civicrm.hrsampledata: Generate random example data
74-
* org.civicrm.hrui: Trim/revise CiviCRM UI for CiviHR users
19+
Please check the [civibuild documentation](https://docs.civicrm.org/dev/en/latest/tools/civibuild/) for more information on all the available params.

doc/RELEASE.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

doc/UPGRADE.md

Lines changed: 0 additions & 24 deletions
This file was deleted.

0 commit comments

Comments
 (0)