Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
E
Eproflearn
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
Requirements
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Test cases
Artifacts
Deploy
Releases
Package registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
liu-puppet-modules
Eproflearn
Commits
a1904473
Commit
a1904473
authored
4 months ago
by
Magnus Svensson
Browse files
Options
Downloads
Plain Diff
Merge branch 'devel' into 'devel'
Burn boilerplate See merge request
!24
parents
6316903a
5c1bd015
No related branches found
No related tags found
1 merge request
!24
Burn boilerplate
Pipeline
#157765
passed
4 months ago
Stage: puppet
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+6
-113
6 additions, 113 deletions
README.md
with
6 additions
and
113 deletions
README.md
+
6
−
113
View file @
a1904473
# eproflearn
Welcome to your new module. A short overview of the generated parts can be found
in the
[
PDK documentation
][
1
]
.
## Documentation ideas
The README template below prov
ides a
starting point with details about what
information to include in your README
.
For
ide
a
s a
bout what to document here see the
[
pdk template
readme
](
https://github.com/puppetlabs/pdk-templates/blob/main/moduleroot_init/README.md.erb
)
.
## Table of Contents
1.
[
Description
](
#description
)
1.
[
Setup - The basics of getting started with eproflearn
](
#setup
)
*
[
What eproflearn affects
](
#what-eproflearn-affects
)
*
[
Setup requirements
](
#setup-requirements
)
*
[
Beginning with eproflearn
](
#beginning-with-eproflearn
)
1.
[
Usage - Configuration options and additional functionality
](
#usage
)
1.
[
Limitations - OS compatibility, etc.
](
#limitations
)
1.
[
Development - Guide for contributing to the module
](
#development
)
## Description
Briefly tell users why they might want to use your module. Explain what your
module does and what kind of problems users can solve with it.
This should be a fairly short description helps the user decide if your module
is what they want.
## Setup
### What eproflearn affects **OPTIONAL**
If it's obvious what your module touches, you can skip this section. For
example, folks can probably figure out that your mysql_instance module affects
their MySQL instances.
If there's more that they should know about, though, this is the place to
mention:
*
Files, packages, services, or operations that the module will alter, impact,
or execute.
*
Dependencies that your module automatically installs.
*
Warnings or other important notices.
### Setup Requirements **OPTIONAL**
If your module requires anything extra before setting up (pluginsync enabled,
another module, etc.), mention it here.
If your most recent release breaks compatibility or requires particular steps
for upgrading, you might want to include an additional "Upgrading" section here.
### Beginning with eproflearn
The very basic steps needed for a user to get the module up and running. This
can include setup steps, if necessary, or it can be an example of the most basic
use of the module.
## Usage
Include usage examples for common use cases in the
**Usage**
section. Show your
users how to use your module to solve problems, and be sure to include code
examples. Include three to five examples of the most important or common tasks a
user can accomplish with your module. Show users how to accomplish more complex
tasks that involve different types, classes, and functions working in tandem.
## Reference
This section is deprecated. Instead, add reference information to your code as
Puppet Strings comments, and then use Strings to generate a REFERENCE.md in your
module. For details on how to add code comments and generate documentation with
Strings, see the
[
Puppet Strings documentation
][
2
]
and
[
style guide
][
3
]
.
If you aren't ready to use Strings yet, manually create a REFERENCE.md in the
root of your module directory and list out each of your module's classes,
defined types, facts, functions, Puppet tasks, task plans, and resource types
and providers, along with the parameters for each.
For each element (class, defined type, function, and so on), list:
*
The data type, if applicable.
*
A description of what the element does.
*
Valid values, if the data type doesn't make it obvious.
*
Default value, if any.
For example:
```
### `pet::cat`
#### Parameters
##### `meow`
Enables vocalization in your cat. Valid options: 'string'.
Default: 'medium-loud'.
```
## Limitations
In the Limitations section, list any incompatibilities, known issues, or other
warnings.
## Development
In the Development section, tell other users the ground rules for contributing
to your project and how they should submit their work.
## Release Notes/Contributors/Etc. **Optional**
If you aren't using changelog, put your release notes here (though you should
consider using changelog). You can also add any additional sections you feel are
necessary or important to include here. Please use the
`##`
header.
[
1
]:
https://puppet.com/docs/pdk/latest/pdk_generating_modules.html
[
2
]:
https://puppet.com/docs/puppet/latest/puppet_strings.html
[
3
]:
https://puppet.com/docs/puppet/latest/puppet_strings_style.html
For how to do it:
https://puppet.com/docs/puppet/latest/puppet_strings.html
https://puppet.com/docs/puppet/latest/puppet_strings_style.html
\ No newline at end of file
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment