Skip to content

Commit e6e76a1

Browse files
committed
docs: update the README file
1 parent dc7d4ba commit e6e76a1

1 file changed

Lines changed: 6 additions & 24 deletions

File tree

README.md

Lines changed: 6 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
-*- mode: markdown; mode: visual-line; -*-
2-
31
# Kernel Puppet Module
42

53
[![Puppet Forge](http://img.shields.io/puppetforge/v/ULHPC/kernel.svg)](https://forge.puppetlabs.com/ULHPC/kernel)
@@ -8,7 +6,7 @@
86

97
Configure various aspects of Linux kernel (modules etc.)
108

11-
Copyright (c) 2015 S. Varrette, H. Cartiaux, V. Plugaru, S. Diehl aka. UL HPC Management Team <hpc-sysadmins@uni.lu>
9+
Copyright (c) 2026 UL HPC Team <hpc-sysadmins@uni.lu>
1210

1311

1412
| [Project Page](https://github.com/ULHPC/puppet-kernel) | [Sources](https://github.com/ULHPC/puppet-kernel) | [Issues](https://github.com/ULHPC/puppet-kernel/issues) |
@@ -32,9 +30,6 @@ This module implements the following elements:
3230
All these components are configured through a set of variables you will find in
3331
[`manifests/params.pp`](manifests/params.pp).
3432

35-
_Note_: the various operations that can be conducted from this repository are piloted from a [`Rakefile`](https://github.com/ruby/rake) and assumes you have a running [Ruby](https://www.ruby-lang.org/en/) installation.
36-
See `docs/contributing.md` for more details on the steps you shall follow to have this `Rakefile` working properly.
37-
3833
## Dependencies
3934

4035
See [`metadata.json`](metadata.json). In particular, this module depends on
@@ -54,9 +49,6 @@ Use it as follows:
5449

5550
include ' kernel'
5651

57-
See also [`tests/init.pp`](tests/init.pp)
58-
59-
6052
### Definition `kernel::module`
6153

6254
The definition `kernel::module` provides ...
@@ -72,9 +64,6 @@ Example:
7264
ensure => 'present',
7365
}
7466

75-
See also [`tests/module.pp`](tests/module.pp)
76-
77-
7867
## Librarian-Puppet / R10K Setup
7968

8069
You can of course configure the kernel module in your `Puppetfile` to make it available with [Librarian puppet](http://librarian-puppet.com/) or
@@ -87,26 +76,19 @@ or, if you prefer to work on the git version:
8776

8877
mod "ULHPC/kernel",
8978
:git => 'https://github.com/ULHPC/puppet-kernel',
90-
:ref => 'production'
91-
92-
## Issues / Feature request
79+
:ref => 'main'
9380

94-
You can submit bug / issues / feature request using the [ULHPC/kernel Puppet Module Tracker](https://github.com/ULHPC/puppet-kernel/issues).
81+
## Developments / Issues / Contributing to the code
9582

96-
## Developments / Contributing to the code
83+
This Puppet Module has been implemented in the context of the [UL HPC](http://hpc.uni.lu) Platform of the [University of Luxembourg](http://www.uni.lu).
84+
It relies on [Vox Pupuli modulesync](https://github.com/voxpupuli/modulesync) for its organization.
9785

9886
If you want to contribute to the code, you shall be aware of the way this module is organized.
9987
These elements are detailed on [`docs/contributing.md`](contributing/index.md).
10088

89+
You can submit bugs / issues / feature requests using the [ULHPC/kernel Puppet Module Tracker](https://github.com/ULHPC/puppet-kernel/issues).
10190
You are more than welcome to contribute to its development by [sending a pull request](https://help.github.com/articles/using-pull-requests).
10291

103-
## Puppet modules tests within a Vagrant box
104-
105-
The best way to test this module in a non-intrusive way is to rely on [Vagrant](http://www.vagrantup.com/).
106-
The `Vagrantfile` at the root of the repository pilot the provisioning various vagrant boxes available on [Vagrant cloud](https://atlas.hashicorp.com/boxes/search?utf8=%E2%9C%93&sort=&provider=virtualbox&q=svarrette) you can use to test this module.
107-
108-
See [`docs/vagrant.md`](vagrant.md) for more details.
109-
11092
## Licence
11193

11294
This project and the sources proposed within this repository are released under the terms of the [GPL-3.0](LICENCE) licence.

0 commit comments

Comments
 (0)