You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This should update to OpenVox in help output and man pages. It also adds
a debranded README and gemspec. Supercedes #2, removing generated man
pages by request. We'll generate them after we're done making changes.
If you'd like to help, feel free to check out this branch/PR and push
your own commits. Stay within scope though, we're focusing first on the
man pages and any user interaction. We'll get to docs later, that's
gonna be a beast.
If you'd like to help, then the easiest way to do so is to check out
this branch/PR and directly add your own commits.
Guidelines
- Do not change any command names.
- *Do not change anything functional!!*
- If any command output includes the name of the tool, change it as
appropriate or add something like "provided by OpenVox"
- if the name is extraneous, then just remove it. For example in the
message "cannot find puppet server" I just removed the word
"puppet".
- When there is a reference to 'Puppet' that means 'the Puppet language'
then change it to 'the Puppet language' to be more precise. (OpenVox
implements the Puppet language. There's no such thing as an OpenVox
language.)
- Do minor content editing for readability as appropriate.
- We are currently focusing only on user experience and branding. It
should be very clear to a user that they're running the OpenVox
implementation of Puppet. It's not yet important that all the internal
and developer documentation or comments reflect this.
Puppet, an automated administrative engine for your Linux, Unix, and Windows systems, performs
3
+
OpenVox is a community implementation of Puppet, an automated administrative engine for your Linux, Unix, and Windows systems, performs
8
4
administrative tasks (such as adding users, installing packages, and updating server
9
5
configurations) based on a centralized specification.
10
6
11
7
## Documentation
12
8
13
-
Documentation for Puppet and related projects can be found online at the
14
-
[Puppet Docs site](https://puppet.com/docs).
9
+
As of now, OpenVox is effectively the same as the original Puppet™️ packages, aside from some minor build pipeline changes and package renaming.
10
+
This means that aside from the installation, all Puppet™️ docs and tutorials will still be completely applicable.
11
+
As the OpenVox project matures, we will create more documentation, guides, and tutorials.
12
+
For the time being though, now you’ll want to hop over to [Puppet’s own documentation](https://puppet.com/docs) and go from there.
15
13
16
14
### HTTP API
17
15
18
16
[HTTP API Index](https://puppet.com/docs/puppet/latest/http_api/http_api_index.html)
19
17
20
18
## Installation
21
19
22
-
The best way to run Puppet is with [Puppet Enterprise (PE)](https://puppet.com/products/puppet-enterprise/),
23
-
which also includes orchestration features, a web console, and professional support.
24
-
The PE documentation is [available here.](https://puppet.com/docs/pe/latest)
25
-
26
-
To install an open source release of Puppet,
27
-
[see the installation guide on the docs site.](https://puppet.com/docs/puppet/latest/installing_and_upgrading.html)
20
+
To install OpenVox,
21
+
[see our installation guide.](https://voxpupuli.org/openvox/install/) and [quickstart page](https://voxpupuli.org/openvox/quickstart/).
28
22
29
-
If you need to run Puppet from source as a tester or developer,
23
+
If you need to run OpenVox from source as a tester or developer,
30
24
see the [Quick Start to Developing on Puppet](docs/quickstart.md) guide.
31
25
32
26
## Developing and Contributing
33
27
34
28
We'd love to get contributions from you! For a quick guide to getting your
35
29
system setup for developing, take a look at our [Quickstart
36
-
Guide](https://github.com/puppetlabs/puppet/blob/main/docs/quickstart.md). Once you are up and running, take a look at the
37
-
[Contribution Documents](https://github.com/puppetlabs/.github/blob/main/CONTRIBUTING.md) to see how to get your changes merged
30
+
Guide](docs/quickstart.md). Once you are up and running, take a look at the
31
+
[Contribution Documents](https://github.com/OpenVoxProject/.github/blob/main/CONTRIBUTING.md) to see how to get your changes merged
38
32
in.
39
33
40
34
For more complete docs on developing with Puppet, take a look at the
41
-
rest of the [developer documents](https://github.com/puppetlabs/puppet/blob/main/docs/index.md).
35
+
rest of the [developer documents](docs/index.md).
42
36
43
37
## Licensing
44
38
45
-
See [LICENSE](https://github.com/puppetlabs/puppet/blob/main/LICENSE) file. Puppet is licensed by Puppet, Inc. under the Apache license. Puppet, Inc. can be contacted at: [email protected]
39
+
See [LICENSE](LICENSE) file. OpenVox is licensed by Vox Pupuli as a community maintained
40
+
implementation of Puppet. Vox Pupuli can be contacted at: [email protected].
41
+
Puppet itself is licensed by Puppet, Inc. under the Apache license. Puppet, Inc. can be contacted at: [email protected]
46
42
47
43
## Support
48
44
49
-
Please log issues in this project's [GitHub Issues](https://github.com/puppetlabs/puppet/issues). A [mailing
50
-
list](https://groups.google.com/forum/?fromgroups#!forum/puppet-users) is
51
-
available for asking questions and getting help from others, or if you prefer chat, we also have a [Puppet Community slack.](https://puppetcommunity.slack.com/)
45
+
Please log issues in this project's [GitHub Issues](/issues).
46
+
Other channels for getting help can be found at our
0 commit comments