Skip to content

Modernize openvox-server install_from_packages page #147

@miharp

Description

@miharp

Overview

The openvox-server install from packages page is significantly out of date and is a single flat page rather than a structured section. The openvox agent install docs demonstrate the target structure.

Current state

A single install_from_packages.markdown covers everything and is linked as a flat item in _data/nav/openvox-server_8x.yml. It also references EOL platforms and outdated Java guidance, and links out to puppet.com instead of openvox equivalents.

Goal: mirror the openvox "Installing and upgrading" section structure

The openvox agent docs break installation into a proper nav section with dedicated pages. The openvox-server docs should do the same. Note that openvox-server is Linux-only — no Windows or macOS pages are needed.

New pages to create in docs/_openvox-server_8x/

Filename Nav title Content
install_pre.md Before you begin Supported OS platforms, Java requirements, firewall/port prerequisites
install_from_packages.md Install OpenVox Server Step-by-step install with separate apt and yum/dnf sections, verification step, service start/enable
install_what_and_where.md What gets installed and where File layout, service names, config paths, log locations
upgrade_minor.md Upgrading OpenVox Server Minor version upgrade procedure

The existing install_from_packages.markdown should be replaced by install_from_packages.md with updated content (or the file renamed and rewritten in place).

Nav update required

Replace the current flat entry in _data/nav/openvox-server_8x.yml:

- text: Installing Puppet Server
  link: install_from_packages.html

With a grouped section:

- text: Installing and upgrading
  items:
  - text: Before you begin
    link: install_pre.html
  - text: Install OpenVox Server
    link: install_from_packages.html
  - text: What gets installed and where
    link: install_what_and_where.html
  - text: Upgrading OpenVox Server
    link: upgrade_minor.html

Use the openvox agent nav in _data/nav/openvox_8x.yml and pages in docs/_openvox_8x/ (e.g. install_pre.markdown, install_linux.markdown, install_what_and_where.markdown, upgrade_minor.md) as structural references.

Content issues to fix

  • Update supported platform list (remove RHEL 6–7, Debian 8–10, Ubuntu 16.04–18.04, SLES 12)
  • Remove outdated Java version table and caveats (backports, universe repo) that no longer apply to supported platforms
  • Split install commands into clearly labeled apt and yum/dnf sections
  • Add a verification step after installation (e.g. puppetserver --version, service status)
  • Expand post-install section inline rather than only linking out

Dead links to fix in the existing page

All of the following point to puppet.com and must be updated to openvox equivalents:

Current link Replace with
https://puppet.com/docs/puppet/latest/puppet_platform.html openvox repositories and packages page
https://tickets.puppet.com/browse/SERVER OpenVoxProject GitHub issues
https://puppet.com/docs/puppet/latest/install_agents.html /openvox/latest/install_linux.html
https://puppet.com/docs/puppetdb/latest/install_via_module.html /openvoxdb/latest/install_via_module.html

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions