Skip to content

Commit 852337e

Browse files
authored
Merge pull request #175 from miharp/feat/modernize-openvox-8x-small-batch
Modernize _openvox_8x: branding and link fixes (small batch)
2 parents 1e6f38d + b34cf29 commit 852337e

15 files changed

Lines changed: 66 additions & 69 deletions

docs/_openvox_8x/bgtm.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@ This means you must `include x` in the main class to ensure the dependency is in
245245

246246
Ensure that the module works in a variety of conditions, and that the options and parameters of your module work together to an appropriate end result.
247247

248-
We recommend several testing frameworks available to help you write unit and acceptance tests. Some of these tools are already included in the [Puppet Development Kit (PDK)](https://www.puppet.com/docs/pdk/latest/pdk.html).
248+
We recommend several testing frameworks available to help you write unit and acceptance tests. Some of these tools are already included in the Puppet Development Kit (PDK).
249249

250250
> **Note:** The open source version of PDK is no longer supported by Puppet. It may still be functional, but no further updates or bug fixes will be provided.
251251
@@ -277,7 +277,7 @@ require 'puppetlabs_spec_helper/rake_tasks'
277277

278278
### Beaker-rspec
279279

280-
[Beaker-rspec](https://github.com/puppetlabs/beaker-rspec) is an acceptance/integration testing framework.
280+
[Beaker-rspec](https://github.com/voxpupuli/beaker-rspec) is an acceptance/integration testing framework.
281281

282282
It provisions one or more virtual machines on various hypervisors (such as [Vagrant](https://www.vagrantup.com/)) and then checks the result of applying your module in a realistic environment.
283283

docs/_openvox_8x/cheatsheet_core_types.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ Manages files, directories, and symlinks.
7171
#### For Normal Files
7272

7373
* [`source`](./type.html#file-attribute-source) -- Where to download contents for the file. Usually a `puppet:///` URL.
74-
* [`content`](./type.html#file-attribute-content) -- The file's desired contents, as a string. Most useful when paired with [templates](https://docs.puppet.com/guides/templating.html), but you can also use the output of the [file function](./function.html#file).
74+
* [`content`](./type.html#file-attribute-content) -- The file's desired contents, as a string. Most useful when paired with [templates](./lang_template.html), but you can also use the output of the [file function](./function.html#file).
7575

7676
{:.section}
7777
#### For Directories
@@ -148,7 +148,7 @@ If a service has a bad init script, you can work around it and manage almost any
148148
{:.concept}
149149
### notify
150150

151-
Logs an arbitrary message, at the `notice` log level. This appears in the POSIX syslog or Windows Event Log on the Puppet agent node and is also logged in reports.
151+
Logs an arbitrary message, at the `notice` log level. This appears in the POSIX syslog or Windows Event Log on the OpenVox agent node and is also logged in reports.
152152

153153
``` puppet
154154
notify { 'This message is getting logged on the agent node.': }

docs/_openvox_8x/functions_legacy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ host converted to an integer, modulo 60. Neither
101101
guarantees uniqueness, but you can't really expect that with a range
102102
of no more than 60 anyway.
103103

104-
But given that functions are run on the puppet master, how do you get at
104+
But given that functions are run on the OpenVox server, how do you get at
105105
the hostname or IP address of the agent node?
106106
The answer is that facts returned by facter can be used in our
107107
functions.

docs/_openvox_8x/functions_ruby_documenting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ layout: default
33
title: "Writing functions in Ruby: Documenting Ruby functions"
44
---
55

6-
[puppet strings]: https://github.com/puppetlabs/puppet-strings
6+
[puppet strings]: https://github.com/voxpupuli/openvox-strings
77
[overview]: ./functions_ruby_overview.html
88
[signatures]: ./functions_ruby_signatures.html
99

docs/_openvox_8x/indirection.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ layout: default
33
built_from_commit: 8c9dd1ff315b738818307cc895942164aba30730
44
title: Indirection Reference
55
toc: columns
6-
canonical: "/puppet/latest/indirection.html"
76
---
87

98

@@ -18,7 +17,7 @@ canonical: "/puppet/latest/indirection.html"
1817
Puppet's indirector support pluggable backends (termini) for a variety of key-value stores (indirections).
1918
Each indirection type corresponds to a particular Ruby class (the "Indirected Class" below) and values are instances of that class.
2019
Each instance's key is available from its `name` method.
21-
The termini can be local (e.g., on-disk files) or remote (e.g., using a REST interface to talk to a puppet master).
20+
The termini can be local (e.g., on-disk files) or remote (e.g., using a REST interface to talk to an OpenVox server).
2221

2322
An indirector has five methods, which are mapped into HTTP verbs for the REST interface:
2423

@@ -328,12 +327,12 @@ A node is composed of its name, its facts, and its environment.
328327
### `exec` terminus
329328

330329
Call an external program to get node information. See
331-
the [External Nodes](https://puppet.com/docs/puppet/latest/lang_write_functions_in_puppet.html) page for more information.
330+
the [External Nodes](./nodes_external.html) page for more information.
332331

333332
### `ldap` terminus
334333

335334
Search in LDAP for node configuration information. See
336-
the [LDAP Nodes](https://puppet.com/docs/puppet/latest/nodes_ldap.html) page for more information. This will first
335+
the [LDAP Nodes](./nodes_ldap.html) page for more information. This will first
337336
search for whatever the certificate name is, then (if that name
338337
contains a `.`) for the short name, then `default`.
339338
Requires ruby-ldap with MRI ruby or jruby-ldap with puppetserver/jruby
@@ -363,7 +362,7 @@ node instance before it is returned.
363362

364363
### `rest` terminus
365364

366-
Get a node via REST. Puppet agent uses this to allow the puppet master
365+
Get a node via REST. OpenVox agent uses this to allow the OpenVox server
367366
to override its environment.
368367

369368
### `store_configs` terminus
@@ -423,6 +422,6 @@ Get status locally. Only used internally.
423422

424423
### `rest` terminus
425424

426-
Get puppet master's status via REST. Useful because it tests the health
425+
Get OpenVox server's status via REST. Useful because it tests the health
427426
of both the web server and the indirector.
428427

docs/_openvox_8x/lang_template.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ title: "Language: Using templates"
66
[interpolate]: ./lang_data_string.html#interpolation
77
[heredoc]: ./lang_data_string.html#heredocs
88
[augeas]: ./resources_augeas.html
9-
[concat]: https://forge.puppetlabs.com/puppetlabs/concat
10-
[file_line]: https://forge.puppetlabs.com/puppetlabs/stdlib
9+
[concat]: https://forge.puppet.com/puppetlabs/concat
10+
[file_line]: https://forge.puppet.com/puppetlabs/stdlib
1111
[functions]: ./lang_functions.html
1212
[epp]: ./lang_template_epp.html
1313
[man epp]: ./man/epp.html
@@ -18,7 +18,7 @@ title: "Language: Using templates"
1818
[valid local variable names]: ./lang_reserved.html#variables
1919
[heredoc]: ./lang_data_string.html#heredocs
2020
[iteration functions]: ./lang_iteration.html
21-
[stdlib]: https://forge.puppetlabs.com/puppetlabs/stdlib
21+
[stdlib]: https://forge.puppet.com/puppetlabs/stdlib
2222

2323
Templates are documents that combine code, data, and literal text to produce a final rendered output. The goal of a template is to manage a complicated piece of text with simple inputs.
2424

@@ -48,7 +48,7 @@ Embedded Ruby (ERB) | `template` | `inline_template`
4848

4949
You can put template files in the `templates` directory of a [module][]. EPP files should have the `.epp` extension, and ERB files should have the `.erb` extension.
5050

51-
To use a template file, evaluate it with the [`template`](https://docs.puppet.com/puppet/latest/function.html#template) (ERB) or [`epp`](https://docs.puppet.com/puppet/latest/function.html#epp) function:
51+
To use a template file, evaluate it with the [`template`](./function.html#template) (ERB) or [`epp`](./function.html#epp) function:
5252

5353
``` puppet
5454
# epp(<FILE REFERENCE>, [<PARAMETER HASH>])

docs/_openvox_8x/lang_template_epp.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: "Language: Embedded Puppet (EPP) template syntax"
66
[erb]: ./lang_template_erb.html
77
[epp]: /openvox/latest/function.html#epp
88
[inline_epp]: /openvox/latest/function.html#inline_epp
9-
[ntp]: https://forge.puppetlabs.com/puppetlabs/ntp
9+
[ntp]: https://forge.puppet.com/puppetlabs/ntp
1010
[functions]: ./lang_functions.html
1111
[hash]: ./lang_data_hash.html
1212
[local scope]: ./lang_scope.html

docs/_openvox_8x/metaparameter.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ layout: default
33
built_from_commit: 8c9dd1ff315b738818307cc895942164aba30730
44
title: Metaparameter Reference
55
toc: columns
6-
canonical: "/puppet/latest/metaparameter.html"
76
---
87

98

@@ -88,7 +87,7 @@ and the second run will log the edit made by Puppet.)
8887
### before
8988

9089
One or more resources that depend on this resource, expressed as
91-
[resource references](https://puppet.com/docs/puppet/latest/lang_data_resource_reference.html).
90+
[resource references](./lang_data_resource_reference.html).
9291
Multiple resources can be specified as an array of references. When this
9392
attribute is present:
9493

@@ -97,7 +96,7 @@ attribute is present:
9796
This is one of the four relationship metaparameters, along with
9897
`require`, `notify`, and `subscribe`. For more context, including the
9998
alternate chaining arrow (`->` and `~>`) syntax, see
100-
[the language page on relationships](https://puppet.com/docs/puppet/latest/lang_relationships.html).
99+
[the language page on relationships](./lang_relationships.html).
101100

102101
### consume
103102

@@ -173,14 +172,14 @@ When applying a resource in noop mode, Puppet will check whether it is in sync,
173172
like it does when running normally. However, if a resource attribute is not in
174173
the desired state (as declared in the catalog), Puppet will take no
175174
action, and will instead report the changes it _would_ have made. These
176-
simulated changes will appear in the report sent to the puppet master, or
175+
simulated changes will appear in the report sent to the OpenVox server, or
177176
be shown on the console if running puppet agent or puppet apply in the
178177
foreground. The simulated changes will not send refresh events to any
179178
subscribing or notified resources, although Puppet will log that a refresh
180179
event _would_ have been sent.
181180

182181
**Important note:**
183-
[The `noop` setting](https://puppet.com/docs/puppet/latest/configuration.html#noop)
182+
[The `noop` setting](./configuration.html#noop)
184183
allows you to globally enable or disable noop mode, but it will _not_ override
185184
the `noop` metaparameter on individual resources. That is, the value of the
186185
global `noop` setting will _only_ affect resources that do not have an explicit
@@ -191,7 +190,7 @@ Valid values are `true`, `false`.
191190
### notify
192191

193192
One or more resources that depend on this resource, expressed as
194-
[resource references](https://puppet.com/docs/puppet/latest/lang_data_resource_reference.html).
193+
[resource references](./lang_data_resource_reference.html).
195194
Multiple resources can be specified as an array of references. When this
196195
attribute is present:
197196

@@ -204,12 +203,12 @@ attribute is present:
204203
This is one of the four relationship metaparameters, along with
205204
`before`, `require`, and `subscribe`. For more context, including the
206205
alternate chaining arrow (`->` and `~>`) syntax, see
207-
[the language page on relationships](https://puppet.com/docs/puppet/latest/lang_relationships.html).
206+
[the language page on relationships](./lang_relationships.html).
208207

209208
### require
210209

211210
One or more resources that this resource depends on, expressed as
212-
[resource references](https://puppet.com/docs/puppet/latest/lang_data_resource_reference.html).
211+
[resource references](./lang_data_resource_reference.html).
213212
Multiple resources can be specified as an array of references. When this
214213
attribute is present:
215214

@@ -218,15 +217,15 @@ attribute is present:
218217
This is one of the four relationship metaparameters, along with
219218
`before`, `notify`, and `subscribe`. For more context, including the
220219
alternate chaining arrow (`->` and `~>`) syntax, see
221-
[the language page on relationships](https://puppet.com/docs/puppet/latest/lang_relationships.html).
220+
[the language page on relationships](./lang_relationships.html).
222221

223222
### schedule
224223

225224
A schedule to govern when Puppet is allowed to manage this resource.
226225
The value of this metaparameter must be the `name` of a `schedule`
227226
resource. This means you must declare a schedule resource, then
228227
refer to it by name; see
229-
[the docs for the `schedule` type](https://puppet.com/docs/puppet/latest/type.html#schedule)
228+
[the docs for the `schedule` type](./type.html#schedule)
230229
for more info.
231230

232231
schedule { 'everyday':
@@ -252,7 +251,7 @@ resources or on classes declared with `include`.
252251
By default, all classes are declared in the `main` stage. To assign a class
253252
to a different stage, you must:
254253

255-
* Declare the new stage as a [`stage` resource](https://puppet.com/docs/puppet/latest/type.html#stage).
254+
* Declare the new stage as a [`stage` resource](./type.html#stage).
256255
* Declare an order relationship between the new stage and the `main` stage.
257256
* Use the resource-like syntax to declare the class, and set the `stage`
258257
metaparameter to the name of the desired stage.
@@ -270,7 +269,7 @@ For example:
270269
### subscribe
271270

272271
One or more resources that this resource depends on, expressed as
273-
[resource references](https://puppet.com/docs/puppet/latest/lang_data_resource_reference.html).
272+
[resource references](./lang_data_resource_reference.html).
274273
Multiple resources can be specified as an array of references. When this
275274
attribute is present:
276275

@@ -283,7 +282,7 @@ attribute is present:
283282
This is one of the four relationship metaparameters, along with
284283
`before`, `require`, and `notify`. For more context, including the
285284
alternate chaining arrow (`->` and `~>`) syntax, see
286-
[the language page on relationships](https://puppet.com/docs/puppet/latest/lang_relationships.html).
285+
[the language page on relationships](./lang_relationships.html).
287286

288287
### tag
289288

docs/_openvox_8x/nodes_external.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,15 @@ Depending on the external data sources you use in your infrastructure, building
1313

1414
## What is an ENC?
1515

16-
An external node classifier is an executable that Puppet Server or Puppet apply can call; it doesn't have to be written in Ruby. Its only argument is the name of the node to be classified, and it returns a YAML document describing the node.
16+
An external node classifier is an executable that OpenVox Server or puppet apply can call; it doesn't have to be written in Ruby. Its only argument is the name of the node to be classified, and it returns a YAML document describing the node.
1717

1818
Inside the ENC, you can reference any data source you want, including [PuppetDB](/openvoxdb/latest). But from Puppet's perspective, it just puts in a node name and gets back a hash of information.
1919

2020
ENCs can co-exist with standard node definitions in `site.pp`, and the classes declared in each source are merged together.
2121

2222
### How merging works
2323

24-
Every node always gets a **node object** (which might be empty or might contain classes, parameters, and an environment) from the configured `node_terminus`. (This setting takes effect where the catalog is compiled; on Puppet Server when using an agent/master arrangement, and on the node itself when using Puppet apply. The default node terminus is `plain`, which returns an empty node object; the `exec` terminus calls an ENC script to determine what should go in the node object.) Every node **might** also get a [node definition][] from the [main manifest][].
24+
Every node always gets a **node object** (which might be empty or might contain classes, parameters, and an environment) from the configured `node_terminus`. (This setting takes effect where the catalog is compiled; on OpenVox Server when using an agent/server arrangement, and on the node itself when using puppet apply. The default node terminus is `plain`, which returns an empty node object; the `exec` terminus calls an ENC script to determine what should go in the node object.) Every node **might** also get a [node definition][] from the [main manifest][].
2525

2626
When compiling a node's catalog, Puppet includes **all** of the following:
2727

@@ -45,7 +45,7 @@ When compiling a node's catalog, Puppet includes **all** of the following:
4545

4646
## Connecting an ENC
4747

48-
To tell Puppet Server to use an ENC, you need to set two [settings](./config_about_settings.html) in the Puppet master's `puppet.conf` file: `node_terminus` has to be set to "exec", and `external_nodes` must have the path to the executable.
48+
To tell OpenVox Server to use an ENC, you need to set two [settings](./config_about_settings.html) in the OpenVox server's `puppet.conf` file: `node_terminus` has to be set to "exec", and `external_nodes` must have the path to the executable.
4949

5050
[master]
5151
node_terminus = exec

docs/_openvox_8x/nodes_ldap.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ The `testserver` node's classes would be `baseclass`, `testing`, and `solaris`.
125125

126126
## Modifying your LDAP schema
127127

128-
You first have to provide the Puppet schema to your LDAP server. You can find the Puppet schema [in Git](http://github.com/puppetlabs/puppet/blob/master/ext/ldap/puppet.schema). Place this schema into your schema directory, on Debian for example this would be /etc/ldap/schema. I recommend keeping the puppet.schema name.
128+
You first have to provide the Puppet schema to your LDAP server. You can find the Puppet schema in the OpenVox source repository under `ext/ldap/puppet.schema`. Place this schema into your schema directory, on Debian for example this would be /etc/ldap/schema. I recommend keeping the puppet.schema name.
129129

130130
With the schema file in place, modify your slapd.conf to load this schema by adding it to the list of schema files loaded:
131131

0 commit comments

Comments
 (0)