Skip to content

Commit 3d3f224

Browse files
authored
Merge pull request #404 from puppetlabs/anchor-tags
(maint) Add HTML anchor tag
2 parents 628ae03 + 28f3cf8 commit 3d3f224

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

README.markdown

+19-1
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,12 @@
2222
5. [Limitations - OS compatibility, etc.](#limitations)
2323
6. [Development - Guide for contributing to the module](#development)
2424

25+
<a id="overview"></a>
2526
## Overview
2627

2728
The vcsrepo module lets you use Puppet to easily deploy content from your version control system (VCS).
2829

30+
<a id="module-description"></a>
2931
## Module description
3032

3133
The vcsrepo module provides a single type with providers to support the following version control systems:
@@ -39,14 +41,17 @@ The vcsrepo module provides a single type with providers to support the followin
3941

4042
**Note:** `git` is the only vcs provider officially [supported by Puppet Inc.](https://forge.puppet.com/supported)
4143

44+
<a id="setup"></a>
4245
## Setup
4346

47+
<a id="setup-requirements"></a>
4448
### Setup requirements
4549

4650
The vcsrepo module does not install any VCS software for you. You must install a VCS before you can use this module.
4751

4852
Like Puppet in general, the vcsrepo module does not automatically create parent directories for the files it manages. Set up any needed directory structures before you start.
4953

54+
<a id="beginning-with-vcsrepo"></a>
5055
### Beginning with vcsrepo
5156

5257
To create and manage a blank repository, define the type `vcsrepo` with a path to your repository and supply the `provider` parameter based on the [VCS you're using](#usage).
@@ -58,10 +63,12 @@ vcsrepo { '/path/to/repo':
5863
}
5964
~~~
6065

66+
<a id="usage"></a>
6167
## Usage
6268

6369
**Note:** `git` is the only vcsrepo provider officially [supported by Puppet Inc.](https://forge.puppet.com/supported)
6470

71+
<a id="git"></a>
6572
### Git
6673

6774
#### Create a blank repository
@@ -230,7 +237,7 @@ vcsrepo { '/path/to/repo':
230237
}
231238
~~~
232239

233-
240+
<a id="bazaar"></a>
234241
### Bazaar
235242

236243
#### Create a blank repository
@@ -279,6 +286,7 @@ vcsrepo { '/path/to/repo':
279286
}
280287
~~~
281288

289+
<a id="cvs"></a>
282290
### CVS
283291

284292
#### Create a blank repository
@@ -362,6 +370,7 @@ vcsrepo { '/path/to/repo':
362370
}
363371
~~~
364372

373+
<a id="mercurial"></a>
365374
### Mercurial
366375

367376
#### Create a blank repository
@@ -457,6 +466,7 @@ vcsrepo { '/path/to/repo':
457466
}
458467
~~~
459468

469+
<a id="perforce"></a>
460470
### Perforce
461471

462472
#### Create an empty workspace
@@ -507,6 +517,7 @@ vcsrepo { '/path/to/repo':
507517
}
508518
~~~
509519

520+
<a id="subversion"></a>
510521
### Subversion
511522

512523
#### Create a blank repository
@@ -657,12 +668,15 @@ vcsrepo { '/path/to/repo':
657668
}
658669
~~~
659670

671+
<a id="reference"></a>
660672
## Reference
661673

674+
<a id="type-vcsrepo"></a>
662675
### Type: vcsrepo
663676

664677
The vcsrepo module adds only one type with several providers. Each provider abstracts a different VCS, and each provider includes a set of features according to its needs.
665678

679+
<a id="providers"></a>
666680
#### Providers
667681

668682
**Note:** Not all features are available with all providers.
@@ -703,6 +717,7 @@ Features: `basic_auth`, `configuration`, `conflict`, `depth`, `filesystem_types`
703717

704718
Parameters: `basic_auth_password`, `basic_auth_username`, `configuration`, `conflict`, `ensure`, `excludes`, `force`, `fstype`, `group`, `includes`, `owner`, `path`, `provider`, `revision`, `source`, `trust_server_cert`
705719

720+
<a id="features"></a>
706721
#### Features
707722

708723
**Note:** Not all features are available with all providers.
@@ -724,6 +739,7 @@ Parameters: `basic_auth_password`, `basic_auth_username`, `configuration`, `conf
724739
* `p4config` - Supports setting the `P4CONFIG` environment. (Available with `p4`.)
725740
* `submodules` - Supports repository submodules which can be optionally initialized. (Available with `git`.)
726741

742+
<a id="parameters"></a>
727743
#### Parameters
728744

729745
All parameters are optional, except where specified otherwise.
@@ -848,6 +864,7 @@ Instructs Subversion to accept SSL server certificates issued by unknown certifi
848864

849865
Specifies the user to run as for repository operations. (Requires the `user` feature.) Valid options: a string containing a username or UID. Default: none.
850866

867+
<a id="limitations"></a>
851868
## Limitations
852869

853870
Git is the only VCS provider officially [supported by Puppet Inc.](https://forge.puppet.com/supported) Git with 3.18 changes the maximum enabled TLS protocol version, this breaks some HTTPS functionality on older operating systems. They are Enterprise Linux 5 and OracleLinux 6.
@@ -856,6 +873,7 @@ The includes parameter is only supported when SVN client version is >= 1.6.
856873

857874
For an extensive list of supported operating systems, see [metadata.json](https://github.com/puppetlabs/puppetlabs-vcsrepo/blob/master/metadata.json)
858875

876+
<a id="development"></a>
859877
## Development
860878

861879
Puppet Inc. modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can't access the huge number of platforms and myriad of hardware, software, and deployment configurations that Puppet is intended to serve.

0 commit comments

Comments
 (0)