Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[3.6] Hide guides which aren't ready for consumption #2353

Merged
merged 2 commits into from
Aug 22, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 5 additions & 0 deletions guides/common/attributes-foreman-deb.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,8 @@
:postgresql-lib-dir: /var/lib/postgresql
:postgresql-data-dir: {postgresql-lib-dir}/13/main
:postgresql-log-dir: /var/log/postgresql

// Some documents are not ready for stable releases, but can be published on nightly
ifeval::["{DocState}" != "nightly"]
:HideDocumentOnStable:
endif::[]
5 changes: 5 additions & 0 deletions guides/common/attributes-foreman-el.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
// Overrides for foreman-el build
:dnf-module: foreman:el8
:dnf-modules: {dnf-module}

// Some documents are not ready for stable releases, but can be published on nightly
ifeval::["{DocState}" != "nightly"]
:HideDocumentOnStable:
endif::[]
5 changes: 5 additions & 0 deletions guides/common/modules/snip_guide-not-ready.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
This guide is not ready yet.

Foreman is a community project.
The source is maintained in https://github.com/theforeman/foreman-documentation/[foreman-documentation on GitHub] where you can create https://github.com/theforeman/foreman-documentation/issues[issues] and https://github.com/theforeman/foreman-documentation/pulls[pull requests].
Thanks for your contribution.
9 changes: 8 additions & 1 deletion guides/doc-Administering_Project/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,13 @@ include::common/header.adoc[]

= {AdministeringDocTitle}

ifeval::["{build}" == "satellite" && "{backend}" == "html5"]
// This guide is not ready for stable releases
ifdef::HideDocumentOnStable[]
include::common/modules/snip_guide-not-ready.adoc[]
endif::[]
ifndef::HideDocumentOnStable[]

ifdef::satellite[]
include::common/modules/proc_providing-feedback-on-red-hat-documentation.adoc[leveloffset=+1]
endif::[]

Expand Down Expand Up @@ -60,3 +66,4 @@ include::common/assembly_searching-and-bookmarking.adoc[leveloffset=+1]

[appendix]
include::common/assembly_administer-settings-information.adoc[leveloffset=+1]
endif::[]
9 changes: 8 additions & 1 deletion guides/doc-Administering_with_Ansible/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,13 @@ include::common/header.adoc[]

= {AdministeringAnsibleDocTitle}

ifeval::["{build}" == "satellite" && "{backend}" == "html5"]
// This guide is not ready for stable releases
ifdef::HideDocumentOnStable[]
include::common/modules/snip_guide-not-ready.adoc[]
endif::[]
ifndef::HideDocumentOnStable[]

ifdef::satellite[]
include::common/modules/proc_providing-feedback-on-red-hat-documentation.adoc[leveloffset=+1]
endif::[]

Expand All @@ -14,3 +20,4 @@ include::common/modules/con_managing-project-with-ansible-collections.adoc[]
include::common/modules/proc_installing-the-project-ansible-modules.adoc[leveloffset=+1]

include::common/modules/proc_viewing-the-project-ansible-modules.adoc[leveloffset=+1]
endif::[]
9 changes: 8 additions & 1 deletion guides/doc-Configuring_Load_Balancer/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,13 @@ include::common/header.adoc[]

= {ConfiguringLoadBalancerDocTitle}

ifeval::["{build}" == "satellite" && "{backend}" == "html5"]
// This guide only works on content proxies, which is Katello only
ifdef::foreman-deb,foreman-el[]
include::common/modules/snip_guide-not-ready.adoc[]
endif::[]
ifndef::foreman-deb,foreman-el[]

ifdef::satellite[]
include::common/modules/proc_providing-feedback-on-red-hat-documentation.adoc[leveloffset=+1]
endif::[]

Expand Down Expand Up @@ -62,3 +68,4 @@ include::common/modules/con_propagating-scap-content-through-the-load-balancer.a
include::common/modules/proc_propagating-scap-content-using-ansible-deployment.adoc[leveloffset=+2]

include::common/modules/proc_propagating-scap-content-using-puppet-deployment.adoc[leveloffset=+2]
endif::[]
9 changes: 6 additions & 3 deletions guides/doc-Deploying_Hosts_AppCentric/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,14 @@ include::common/header.adoc[]
:application_centric_deployment:
:context: application_centric_deployment

// Render only for relevant and finished contexts
ifdef::foreman-el,katello,orcharhino[]

= {AppCentricDeploymentDocTitle}

// Render only for relevant and finished contexts
ifdef::HideDocumentOnStable,foreman-deb,satellite[]
include::common/modules/snip_guide-not-ready.adoc[]
endif::[]
ifndef::HideDocumentOnStable,foreman-deb,satellite[]

include::common/modules/con_introduction-to-application-centric-deployment.adoc[leveloffset=+1]

include::common/modules/con_application-centric-deployment-usage-example.adoc[leveloffset=+2]
Expand Down
9 changes: 8 additions & 1 deletion guides/doc-Deploying_Project_on_AWS/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,13 @@ include::common/header.adoc[]

= {DeployingAWSDocTitle}

ifeval::["{build}" == "satellite" && "{backend}" == "html5"]
// This guide is not ready for stable releases
ifdef::HideDocumentOnStable[]
include::common/modules/snip_guide-not-ready.adoc[]
endif::[]
ifndef::HideDocumentOnStable[]

ifdef::satellite[]
include::common/modules/proc_providing-feedback-on-red-hat-documentation.adoc[leveloffset=+1]
endif::[]

Expand All @@ -20,3 +26,4 @@ include::topics/AWS_Installing_Satellite_AWS.adoc[leveloffset=+1]
include::topics/AWS_Installing_Capsule_on_AWS.adoc[leveloffset=+1]

include::topics/AWS-registering-hosts.adoc[leveloffset=+1]
endif::[]
10 changes: 9 additions & 1 deletion guides/doc-Installing_Proxy/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,14 @@ include::common/header.adoc[]

= {InstallingSmartProxyDocTitle}

ifeval::["{build}" == "satellite" && "{backend}" == "html5"]
// This guide is not ready for stable releases and on Debian
// Though it also contains many errors on EL
ifdef::HideDocumentOnStable,foreman-deb[]
include::common/modules/snip_guide-not-ready.adoc[]
endif::[]
ifndef::HideDocumentOnStable,foreman-deb[]

ifdef::satellite[]
include::common/modules/proc_providing-feedback-on-red-hat-documentation.adoc[leveloffset=+1]
endif::[]

Expand Down Expand Up @@ -39,3 +46,4 @@ include::common/modules/ref_dhcp-isc-settings.adoc[leveloffset=+1]
[appendix]
include::common/modules/ref_dhcp-options-for-network-configuration.adoc[leveloffset=+1]
endif::[]
endif::[]
10 changes: 9 additions & 1 deletion guides/doc-Installing_Server/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,13 @@ include::common/header.adoc[]

= {InstallingServerDocTitle}

ifeval::["{build}" == "satellite" && "{backend}" == "html5"]
// This guide is not ready for stable releases
ifdef::HideDocumentOnStable[]
include::common/modules/snip_guide-not-ready.adoc[]
endif::[]
ifndef::HideDocumentOnStable[]

ifdef::satellite[]
include::common/modules/proc_providing-feedback-on-red-hat-documentation.adoc[leveloffset=+1]
endif::[]

Expand Down Expand Up @@ -82,3 +88,5 @@ include::common/modules/con_applying-custom-configuration.adoc[leveloffset=+1]

[appendix]
include::common/modules/proc_restoring-manual-changes-overwritten-by-a-puppet-run.adoc[leveloffset=+1]

endif::[]
11 changes: 6 additions & 5 deletions guides/doc-Installing_Server_Disconnected/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,15 @@ include::common/header.adoc[]
:mode: disconnected
:ProductName: {ProjectServer}

// Render only for relevant and finished contexts
ifdef::satellite[]

= {InstallingServerDisconnectedDocTitle}

ifeval::["{build}" == "satellite" && "{backend}" == "html5"]
include::common/modules/proc_providing-feedback-on-red-hat-documentation.adoc[leveloffset=+1]
// This guide is not ready for stable releases
ifndef::satellite[]
include::common/modules/snip_guide-not-ready.adoc[]
endif::[]
ifdef::satellite[]

include::common/modules/proc_providing-feedback-on-red-hat-documentation.adoc[leveloffset=+1]

include::common/assembly_preparing-environment-for-installation.adoc[leveloffset=+1]

Expand Down
2 changes: 1 addition & 1 deletion guides/doc-Managing_Configurations_Ansible/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ include::common/header.adoc[]

= {ManagingConfigurationsAnsibleDocTitle}

ifeval::["{build}" == "satellite" && "{backend}" == "html5"]
ifdef::satellite[]
include::common/modules/proc_providing-feedback-on-red-hat-documentation.adoc[leveloffset=+1]
endif::[]

Expand Down
9 changes: 8 additions & 1 deletion guides/doc-Managing_Configurations_Puppet/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,13 @@ include::common/header.adoc[]

= {ManagingConfigurationsPuppetDocTitle}

ifeval::["{build}" == "satellite" && "{backend}" == "html5"]
// This guide is not ready for stable releases
ifdef::HideDocumentOnStable[]
include::common/modules/snip_guide-not-ready.adoc[]
endif::[]
ifndef::HideDocumentOnStable[]

ifdef::satellite[]
include::common/modules/proc_providing-feedback-on-red-hat-documentation.adoc[leveloffset=+1]
endif::[]

Expand Down Expand Up @@ -78,3 +84,4 @@ include::common/modules/proc_setting-the-puppet-out-of-sync-interval.adoc[levelo
include::common/modules/proc_overriding-out-of-sync-interval-for-a-host-group.adoc[leveloffset=+2]

include::common/modules/proc_overriding-out-of-sync-interval-for-an-individual-host.adoc[leveloffset=+2]
endif::[]
8 changes: 7 additions & 1 deletion guides/doc-Managing_Content/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,17 @@ include::common/header.adoc[]

= {ContentManagementDocTitle}

ifeval::["{build}" == "satellite" && "{backend}" == "html5"]
ifdef::satellite[]
include::common/modules/proc_providing-feedback-on-red-hat-documentation.adoc[leveloffset=+1]
endif::[]

// Render only for relevant and finished contexts
ifndef::katello,satellite,orcharhino[]
Content management requires the Katello plugin.
Conversion of an existing installation is not supported.
// Can't use the regular macros because they are for the wrong flavor
See the {BaseURL}Installing_Server/index-katello.html[Katello installation guide] on how to install Katello.
endif::[]
ifdef::katello,satellite,orcharhino[]

include::common/modules/con_introduction-to-content-management.adoc[leveloffset=+1]
Expand Down
11 changes: 7 additions & 4 deletions guides/doc-Managing_Hosts/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,15 @@ include::common/header.adoc[]
:context: managing-hosts
:managing-hosts:

// Render only for relevant and finished contexts
ifdef::foreman-el,katello,satellite,orcharhino[]

= {ManagingHostsDocTitle}

ifeval::["{build}" == "satellite" && "{backend}" == "html5"]
// This guide is not ready for stable releases and not on Debian
ifdef::HideDocumentOnStable,foreman-deb[]
include::common/modules/snip_guide-not-ready.adoc[]
endif::[]
ifndef::HideDocumentOnStable,foreman-deb[]

ifdef::satellite[]
include::common/modules/proc_providing-feedback-on-red-hat-documentation.adoc[leveloffset=+1]
endif::[]

Expand Down
8 changes: 7 additions & 1 deletion guides/doc-Managing_Organizations_and_Locations/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,13 @@ include::common/header.adoc[]

= {ManagingOrganizationsLocationsDocTitle}

ifndef::satellite[]
// This guide is not ready for stable releases
// Satellite publishes this documentation elsewhere
ifdef::HideDocumentOnStable,satellite[]
include::common/modules/snip_guide-not-ready.adoc[]
endif::[]
ifndef::HideDocumentOnStable,satellite[]

include::common/modules/con_introduction-to-organization-and-location-context.adoc[leveloffset=+1]

include::common/assembly_managing-organizations.adoc[leveloffset=+1]
Expand Down
7 changes: 7 additions & 0 deletions guides/doc-Managing_Security_Compliance/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,12 @@ This feature is not available for Debian/Ubuntu.
endif::[]
ifndef::foreman-deb[]

// This guide is not ready for stable releases
ifdef::HideDocumentOnStable[]
include::common/modules/snip_guide-not-ready.adoc[]
endif::[]
ifndef::HideDocumentOnStable[]

include::common/modules/con_security-compliance-management.adoc[leveloffset=+1]

include::common/modules/con_security-content-automation-protocol.adoc[leveloffset=+1]
Expand Down Expand Up @@ -84,3 +90,4 @@ include::common/modules/proc_deleting-a-compliance-report.adoc[leveloffset=+2]
include::common/modules/proc_deleting-multiple-compliance-reports.adoc[leveloffset=+2]

endif::[]
endif::[]
9 changes: 8 additions & 1 deletion guides/doc-Planning_for_Project/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,13 @@ include::common/header.adoc[]

= {PlanningDocTitle}

ifeval::["{build}" == "satellite" && "{backend}" == "html5"]
// This guide is Katello specific, in particular the diagrams
ifdef::foreman-el,foreman-deb[]
include::common/modules/snip_guide-not-ready.adoc[]
endif::[]
ifndef::foreman-el,foreman-deb[]

ifdef::satellite[]
include::common/modules/proc_providing-feedback-on-red-hat-documentation.adoc[leveloffset=+1]
endif::[]

Expand Down Expand Up @@ -34,3 +40,4 @@ include::topics/Deployment_Scenarios.adoc[]
include::topics/Required_Technical_Users.adoc[]

include::topics/Glossary.adoc[]
endif::[]
9 changes: 8 additions & 1 deletion guides/doc-Provisioning_Hosts/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,13 @@ include::common/header.adoc[]

= {ProvisioningDocTitle}

ifeval::["{build}" == "satellite" && "{backend}" == "html5"]
// This guide is not ready for stable releases
ifdef::HideDocumentOnStable[]
include::common/modules/snip_guide-not-ready.adoc[]
endif::[]
ifndef::HideDocumentOnStable[]

ifdef::satellite[]
include::common/modules/proc_providing-feedback-on-red-hat-documentation.adoc[leveloffset=+1]
endif::[]

Expand Down Expand Up @@ -62,3 +68,4 @@ endif::[]

[appendix]
include::common/modules/ref_host-parameter-hierarchy.adoc[leveloffset=+1]
endif::[]
7 changes: 7 additions & 0 deletions guides/doc-Quickstart/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@ include::common/header.adoc[]

= {QuickstartDocTitle}

// This guide is not ready for stable releases
ifdef::HideDocumentOnStable[]
include::common/modules/snip_guide-not-ready.adoc[]
endif::[]
ifndef::HideDocumentOnStable[]

The Foreman installer is a collection of Puppet modules that installs everything required for a full working Foreman setup. It uses native OS packaging (e.g. RPM and .deb packages) and adds necessary configuration for the complete installation.

Components include the Foreman web UI, Smart Proxy, a Puppet server, TFTP, DNS and DHCP servers. It is configurable and the Puppet modules can be read or run in “no-op” mode to see what changes it will make.
Expand Down Expand Up @@ -34,3 +40,4 @@ To run the installer, execute:
----

When the installer has completed, details will be printed about where to find Foreman and the Smart Proxy.
endif::[]
9 changes: 8 additions & 1 deletion guides/doc-Tuning_Performance/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,13 @@ include::common/header.adoc[]

= {TuningDocTitle}

ifeval::["{build}" == "satellite" && "{backend}" == "html5"]
// This guide is not ready for stable releases
ifdef::HideDocumentOnStable[]
include::common/modules/snip_guide-not-ready.adoc[]
endif::[]
ifndef::HideDocumentOnStable[]

ifdef::satellite[]
include::common/modules/proc_providing-feedback-on-red-hat-documentation.adoc[leveloffset=+1]
endif::[]

Expand Down Expand Up @@ -81,3 +87,4 @@ include::common/modules/con_smart-proxy-configuration-tuning.adoc[leveloffset=+2

include::common/modules/con_smartproxy_performance_tests.adoc[leveloffset=+3]
endif::[]
endif::[]
8 changes: 4 additions & 4 deletions guides/doc-Upgrading_and_Updating/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,6 @@ include::common/header.adoc[]

= {UpgradingDocTitle}

ifeval::["{build}" == "satellite" && "{backend}" == "html5"]
include::common/modules/proc_providing-feedback-on-red-hat-documentation.adoc[leveloffset=+1]
endif::[]

In this guide, the terms upgrade, update, and migrate have the following meanings:

Upgrading::
Expand All @@ -24,6 +20,10 @@ endif::[]
Migrating::
The process of moving an existing {Project} installation to a new instance.

ifdef::satellite[]
include::common/modules/proc_providing-feedback-on-red-hat-documentation.adoc[leveloffset=+1]
endif::[]

// Upgrading Satellite Server overview
include::topics/upgrading_overview.adoc[leveloffset=+1]

Expand Down