Documentation team meeting 2023-09-18

Development documentation
1

General

  • @ekohl: PRProcessor applying labels update

Mini retrospective:

Mini retrospective on meeting format:

  • What works well?
  • What doesn’t work well?
  • What should we improve?

PR Triage

Anything updated within the past week can be ignored during triage. If someone wants to discuss a specific issue/PR then it should be added to the agenda.

2

General

Making docs primary documentation source

Went over the proposal: Making docs.theforeman.org the primary documentation source

@ekohl’s initial suggestion was to map all the files in the repository so that we can redirect users. It was raised that this may be a very big task and not everyone can make the call if content should be dropped. While discussing about how to spit up the big task into smaller ones it was suggested to first focus on what Foreman and plugins actually link to (from within the UI). Both Orcharhino and Satellite map this to their own branded documentation, so there are some lists.

AI: @ekohl look at sharing the Satellite mapping
AI: @maximilian look at sharing the Orcharhino mapping

Then we ran out of time, but will continue next week.

Triage

We ran out of time and didn’t look at these.

3

List of IDs from orcharhino based on Foreman 3.5:

Architectures
ARFReports
Auditing
Bookmarks
Classes
ComputeResources
ConfigurationOptions
CreatingSCAPcontent
EC2
Environments
ExecutingaJob
ExternalAuthentication
FactsandtheENC
foreman_discovery
ForemanRemoteExecution
GettingHelp
GoogleComputeEngineNotes
HTTP(S)Proxy
ImportingRoles
index
InstallationMedia
JobTemplates
LDAPAuthentication
LibvirtNote
Networking
OperatingSystems
ParameterizedClasses
Parameters
PartitionTables
Policydeploymentoptions
Provisioning
ProvisioningTemplates
PuppetReports
Realm
Reports
ReportTemplates
RHEVNotes
RolesandPermissions
SaltVariables
Searching
SmartMatchers
SmartProxies
SmartVariables
Tailoringfiles
UsingComputeProfiles
using-config-groups
Variables
VMwareNotes
4

From Satellite I see we link to these IDs

Ansible

ImportingRoles
Variables

Managing Hosts

ForemanRemoteExecution
ExecutingaJob
JobTemplates
ReportTemplates
Reports

Provisioning Hosts

Architectures
Provisioning
InstallationMedia
PartitionTables
ProvisioningTemplates
OperatingSystems
UsingComputeProfiles
ComputeResources
NoVNC
VMwareNotes
RHEVNotes
OpenStackNotes
LibvirtNote
EC2
GoogleComputeEngineNotes
Networking

Puppet Guide

FactsandtheENC
using-config-groups
SmartMatchers
Parameters
Classes
Environments

Administering

ConfigurationOptions
PuppetReports
Mail_Notifications
Realm
Searching
RolesandPermissions
LDAPAuthentication
Bookmarks
Policydeploymentoptions
CreatingSCAPcontent

Planning

SmartProxies
Auditing

Install

HTTP(S)Proxy

Misc

GettingHelp

plugins

foreman_azure
foreman_discovery