Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improved setup instructions in README #1

Merged
merged 6 commits into from
Dec 21, 2016
Merged

Improved setup instructions in README #1

merged 6 commits into from
Dec 21, 2016

Conversation

tyearke
Copy link
Contributor

@tyearke tyearke commented Dec 15, 2016

Description

This updates the README file based on feedback from various XDMoD team members.

Motivation and Context

This will make getting started with Open XDMoD easier.

Tests performed

I checked that the new README file renders correctly on GitHub.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project as found in the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@@ -39,16 +39,52 @@ Before getting started, please see
## Developing
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lets add this to the Contributing section:

If you wish to make contributions to XDMoD you will need to follow these steps:

  1. Fork the appropriate XDMoD repos
  2. Clone the repos onto your local system
  3. Develop and test
  4. Commit changes to your fork on Github
  5. Initiate a pull request for review by the XDMoD team

A list of supported XDMoD repos can be found at [XDMoD Repo manifest repository][xdmod-repo-manifest].

@smgallo
Copy link
Contributor

smgallo commented Dec 16, 2016

And also on the manifest page explicitly list the repos that are part of the XDMoD framework

@tyearke tyearke added the documentation Documentation updates label Dec 16, 2016
@tyearke tyearke added this to the Open XDMoD 6.5.0 milestone Dec 16, 2016
@jpwhite4
Copy link
Member

You need to include instructions about how to install on Centos 6 & 7. This OS has the version of php that doesn't do correct validation of ssl certs. The current instructions to run composer install fail out of the box on both OSes

@jpwhite4
Copy link
Member

I did see some warning messages when building the RPMs as per these instructions:

xdmod:

warning: File listed twice: /usr/share/xdmod/html/robots.txt

xdmod-supremm:

[WARN] File not found '/home/jpwhite4/rpmbuild/BUILDROOT/xdmod-supremm-6.0.0-1.0.el6.x86_64/usr/share/xdmod/configuration/linker.php'
[WARN] File not found '/home/jpwhite4/rpmbuild/BUILDROOT/xdmod-supremm-6.0.0-1.0.el6.x86_64/usr/share/xdmod/reporting/jasper_builder/ReportBuilder.sh'
[WARN] File not found '/home/jpwhite4/rpmbuild/BUILDROOT/xdmod-supremm-6.0.0-1.0.el6.x86_64/usr/share/xdmod/configuration/constants.php'
[WARN] File not found '/home/jpwhite4/rpmbuild/BUILDROOT/xdmod-supremm-6.0.0-1.0.el6.x86_64/etc/xdmod/portal_settings.ini'
[WARN] File not found '/home/jpwhite4/rpmbuild/BUILDROOT/xdmod-supremm-6.0.0-1.0.el6.x86_64/usr/local/xdmod/etc/logrotate.d/xdmod'
[WARN] File not found '/home/jpwhite4/rpmbuild/BUILDROOT/xdmod-supremm-6.0.0-1.0.el6.x86_64/etc/cron.d/xdmod'
[WARN] File not found '/home/jpwhite4/rpmbuild/BUILDROOT/xdmod-supremm-6.0.0-1.0.el6.x86_64/usr/local/xdmod/etc/apache.d/xdmod.conf'

Suggest that we add some documentation somewhere that explains these are benign. This should help reduce some support requests.

@tyearke tyearke merged commit c9e3d28 into ubccr:xdmod6.5 Dec 21, 2016
tyearke referenced this pull request in tyearke/xdmod Feb 13, 2017
chakrabortyr added a commit that referenced this pull request Jul 19, 2017
Update from latest changes
jtpalmer pushed a commit to jtpalmer/xdmod that referenced this pull request May 31, 2019
connersaeli pushed a commit to connersaeli/xdmod that referenced this pull request Feb 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation updates
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants