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

Add a banner for unsupported and pre-release #3653

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions guides/common/header.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,13 @@ endif::[]
ifeval::["{DocState}" == "nightly"]
:revnumber: Nightly
:revdate: published {date_my}
++++
<!-- "Fork me on GitHub" CSS ribbon v0.2.3 | MIT License -->
<!-- https://github.com/simonwhitaker/github-fork-ribbon-css -->
<a class="github-fork-ribbon right-top fixed" data-ribbon="Pre-release version" title="Pre-release version">
Pre-release version
</a>
++++
endif::[]
ifeval::["{DocState}" == "stable"]
:revnumber: {ProjectVersion}
Expand All @@ -18,4 +25,11 @@ endif::[]
ifeval::["{DocState}" == "unsupported"]
:revnumber: {ProjectVersion} (unsupported)
:revdate: published {date_mdy}
++++
<!-- "Fork me on GitHub" CSS ribbon v0.2.3 | MIT License -->
<!-- https://github.com/simonwhitaker/github-fork-ribbon-css -->
<a class="github-fork-ribbon right-top fixed" href="https://docs.theforeman.org" data-ribbon="Unsupported version" title="Unsupported version">
Unsupported version
</a>
++++
endif::[]
2 changes: 1 addition & 1 deletion guides/common/modules/snip_guide-not-ready.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
This guide is not ready yet.
== 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].
Expand Down
4 changes: 4 additions & 0 deletions guides/doc-Configuring_virt-who_VM_Subscriptions/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,13 @@ include::common/header.adoc[]
= {ConfiguringVMSubscriptionsDocTitle}

ifdef::foreman-deb[]
== Katello plugin required

You cannot use the virt-who plugin because it requires the Katello plugin, which is not supported on Debian or Ubuntu.
endif::[]
ifdef::foreman-el[]
== Katello plugin required

You cannot use the virt-who plugin without the Katello plugin.
endif::[]

Expand Down
4 changes: 4 additions & 0 deletions guides/doc-Managing_Content/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,16 @@ include::common/header.adoc[]
= {ContentManagementDocTitle}

ifdef::foreman-deb[]
== Katello plugin required

The Katello plugin required to manage content in Foreman is not supported for {Project} on {DL}.

With {Project} and Katello on {EL}, you can provide content to hosts running {DL}.
endif::[]

ifdef::foreman-el,foreman-deb[]
== Katello plugin required

If you want to manage content using Foreman/Katello, you have to run Foreman/Katello on {EL}.
Converting an existing Foreman installation on {EL} to Foreman/Katello is not supported.
For more information, see {BaseURL}Installing_Server/index-katello.html[Installing Foreman Server with Katello plugin on {EL}].
Expand Down
2 changes: 2 additions & 0 deletions guides/doc-Managing_Security_Compliance/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ include::common/header.adoc[]
= {ManagingSecurityDocTitle}

ifdef::foreman-deb[]
== Unavailable for Debian/Ubuntu

This feature is not available for {Project} on {DL}.
// Because we don't package foreman_openscap for Debian
endif::[]
Expand Down
2 changes: 1 addition & 1 deletion guides/doc-Planning_for_Project/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ ifdef::satellite[]
include::common/modules/proc_providing-feedback-on-red-hat-documentation.adoc[leveloffset=+1]
endif::[]

include::common/modules/con_foreman-overview-and-concepts.adoc[]
include::common/modules/con_foreman-overview-and-concepts.adoc[leveloffset=+1]

include::common/assembly_content-and-patch-management-with-project.adoc[leveloffset=+1]

Expand Down
146 changes: 146 additions & 0 deletions web/content/css/_ribbon.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
/*!
* "Fork me on GitHub" CSS ribbon v0.2.3 | MIT License
* https://github.com/simonwhitaker/github-fork-ribbon-css

The MIT License (MIT)

Copyright (c) 2013 Simon Whitaker

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/

.github-fork-ribbon {
width: 12.1em;
height: 12.1em;
position: absolute;
overflow: hidden;
top: 0;
right: 0;
z-index: 9999;
pointer-events: none;
font-size: 13px;
text-decoration: none;
text-indent: -999999px;
}

.github-fork-ribbon.fixed {
position: fixed;
}

.github-fork-ribbon:hover, .github-fork-ribbon:active {
background-color: rgba(0, 0, 0, 0.0);
}

.github-fork-ribbon:before, .github-fork-ribbon:after {
/* The right and left classes determine the side we attach our banner to */
position: absolute;
display: block;
width: 15.38em;
height: 1.54em;

top: 3.23em;
right: -3.23em;

-webkit-box-sizing: content-box;
-moz-box-sizing: content-box;
box-sizing: content-box;

-webkit-transform: rotate(45deg);
-moz-transform: rotate(45deg);
-ms-transform: rotate(45deg);
-o-transform: rotate(45deg);
transform: rotate(45deg);
}

.github-fork-ribbon:before {
content: "";

/* Add a bit of padding to give some substance outside the "stitching" */
padding: .38em 0;

/* Set the base colour */
background-color: #a00;

/* Set a gradient: transparent black at the top to almost-transparent black at the bottom */
background-image: -webkit-gradient(linear, left top, left bottom, from(rgba(0, 0, 0, 0)), to(rgba(0, 0, 0, 0.15)));
background-image: -webkit-linear-gradient(top, rgba(0, 0, 0, 0), rgba(0, 0, 0, 0.15));
background-image: -moz-linear-gradient(top, rgba(0, 0, 0, 0), rgba(0, 0, 0, 0.15));
background-image: -ms-linear-gradient(top, rgba(0, 0, 0, 0), rgba(0, 0, 0, 0.15));
background-image: -o-linear-gradient(top, rgba(0, 0, 0, 0), rgba(0, 0, 0, 0.15));
background-image: linear-gradient(to bottom, rgba(0, 0, 0, 0), rgba(0, 0, 0, 0.15));

/* Add a drop shadow */
-webkit-box-shadow: 0 .15em .23em 0 rgba(0, 0, 0, 0.5);
-moz-box-shadow: 0 .15em .23em 0 rgba(0, 0, 0, 0.5);
box-shadow: 0 .15em .23em 0 rgba(0, 0, 0, 0.5);

pointer-events: auto;
}

.github-fork-ribbon:after {
/* Set the text from the data-ribbon attribute */
content: attr(data-ribbon);

/* Set the text properties */
color: #fff;
font: 700 1em "Helvetica Neue", Helvetica, Arial, sans-serif;
line-height: 1.54em;
text-decoration: none;
text-shadow: 0 -.08em rgba(0, 0, 0, 0.5);
text-align: center;
text-indent: 0;

/* Set the layout properties */
padding: .15em 0;
margin: .15em 0;

/* Add "stitching" effect */
border-width: .08em 0;
border-style: dotted;
border-color: #fff;
border-color: rgba(255, 255, 255, 0.7);
}

.github-fork-ribbon.left-top, .github-fork-ribbon.left-bottom {
right: auto;
left: 0;
}

.github-fork-ribbon.left-bottom, .github-fork-ribbon.right-bottom {
top: auto;
bottom: 0;
}

.github-fork-ribbon.left-top:before, .github-fork-ribbon.left-top:after, .github-fork-ribbon.left-bottom:before, .github-fork-ribbon.left-bottom:after {
right: auto;
left: -3.23em;
}

.github-fork-ribbon.left-bottom:before, .github-fork-ribbon.left-bottom:after, .github-fork-ribbon.right-bottom:before, .github-fork-ribbon.right-bottom:after {
top: auto;
bottom: 3.23em;
}

.github-fork-ribbon.left-top:before, .github-fork-ribbon.left-top:after, .github-fork-ribbon.right-bottom:before, .github-fork-ribbon.right-bottom:after {
-webkit-transform: rotate(-45deg);
-moz-transform: rotate(-45deg);
-ms-transform: rotate(-45deg);
-o-transform: rotate(-45deg);
transform: rotate(-45deg);
}
1 change: 1 addition & 0 deletions web/content/css/default.scss
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
@import "asciidoc";
@import "nav";
@import "ribbon";
@import "site";