mirror of
https://github.com/ansible/awx.git
synced 2026-03-13 23:17:32 -02:30
Merge pull request #9815 from keithjgrant/4837-docs-links
Create single source of truth for outgoing Docs link URLs SUMMARY Adds a utility function to generate links to the correct version of documentation and updates/adds a number of docs links throughout the app. Addresses #8428 ISSUE TYPE Feature Pull Request COMPONENT NAME UI Reviewed-by: Jake McDermott <yo@jakemcdermott.me>
This commit is contained in:
@@ -78,7 +78,8 @@
|
||||
"src",
|
||||
"theme",
|
||||
"gridColumns",
|
||||
"rows"
|
||||
"rows",
|
||||
"href"
|
||||
],
|
||||
"ignore": ["Ansible", "Tower", "JSON", "YAML", "lg"],
|
||||
"ignoreComponent": [
|
||||
|
||||
@@ -22,6 +22,8 @@ import {
|
||||
} from '@patternfly/react-icons';
|
||||
import { WorkflowApprovalsAPI } from '../../api';
|
||||
import useRequest from '../../util/useRequest';
|
||||
import getDocsBaseUrl from '../../util/getDocsBaseUrl';
|
||||
import { useConfig } from '../../contexts/Config';
|
||||
import useWsPendingApprovalCount from './useWsPendingApprovalCount';
|
||||
|
||||
const PendingWorkflowApprovals = styled.div`
|
||||
@@ -35,9 +37,6 @@ const PendingWorkflowApprovalBadge = styled(Badge)`
|
||||
margin-left: 10px;
|
||||
`;
|
||||
|
||||
const DOCLINK =
|
||||
'https://docs.ansible.com/ansible-tower/latest/html/userguide/index.html';
|
||||
|
||||
function PageHeaderToolbar({
|
||||
isAboutDisabled,
|
||||
onAboutClick,
|
||||
@@ -47,6 +46,7 @@ function PageHeaderToolbar({
|
||||
}) {
|
||||
const [isHelpOpen, setIsHelpOpen] = useState(false);
|
||||
const [isUserOpen, setIsUserOpen] = useState(false);
|
||||
const config = useConfig();
|
||||
|
||||
const {
|
||||
request: fetchPendingApprovalCount,
|
||||
@@ -101,37 +101,39 @@ function PageHeaderToolbar({
|
||||
</Link>
|
||||
</PageHeaderToolsItem>
|
||||
</Tooltip>
|
||||
<Tooltip position="bottom" content={<div>{i18n._(t`Info`)}</div>}>
|
||||
<PageHeaderToolsItem>
|
||||
<Dropdown
|
||||
isPlain
|
||||
isOpen={isHelpOpen}
|
||||
position={DropdownPosition.right}
|
||||
onSelect={handleHelpSelect}
|
||||
toggle={
|
||||
<DropdownToggle
|
||||
onToggle={setIsHelpOpen}
|
||||
aria-label={i18n._(t`Info`)}
|
||||
>
|
||||
<QuestionCircleIcon />
|
||||
</DropdownToggle>
|
||||
}
|
||||
dropdownItems={[
|
||||
<DropdownItem key="help" target="_blank" href={DOCLINK}>
|
||||
{i18n._(t`Help`)}
|
||||
</DropdownItem>,
|
||||
<DropdownItem
|
||||
key="about"
|
||||
component="button"
|
||||
isDisabled={isAboutDisabled}
|
||||
onClick={onAboutClick}
|
||||
>
|
||||
{i18n._(t`About`)}
|
||||
</DropdownItem>,
|
||||
]}
|
||||
/>
|
||||
</PageHeaderToolsItem>
|
||||
</Tooltip>
|
||||
<PageHeaderToolsItem>
|
||||
<Dropdown
|
||||
isPlain
|
||||
isOpen={isHelpOpen}
|
||||
position={DropdownPosition.right}
|
||||
onSelect={handleHelpSelect}
|
||||
toggle={
|
||||
<DropdownToggle
|
||||
onToggle={setIsHelpOpen}
|
||||
aria-label={i18n._(t`Info`)}
|
||||
>
|
||||
<QuestionCircleIcon />
|
||||
</DropdownToggle>
|
||||
}
|
||||
dropdownItems={[
|
||||
<DropdownItem
|
||||
key="help"
|
||||
target="_blank"
|
||||
href={`${getDocsBaseUrl(config)}//html/userguide/index.html`}
|
||||
>
|
||||
{i18n._(t`Help`)}
|
||||
</DropdownItem>,
|
||||
<DropdownItem
|
||||
key="about"
|
||||
component="button"
|
||||
isDisabled={isAboutDisabled}
|
||||
onClick={onAboutClick}
|
||||
>
|
||||
{i18n._(t`About`)}
|
||||
</DropdownItem>,
|
||||
]}
|
||||
/>
|
||||
</PageHeaderToolsItem>
|
||||
<Tooltip position="left" content={<div>{i18n._(t`User`)}</div>}>
|
||||
<PageHeaderToolsItem>
|
||||
<Dropdown
|
||||
|
||||
0
awx/ui_next/src/components/DocsLink/DocsLink.jsx
Normal file
0
awx/ui_next/src/components/DocsLink/DocsLink.jsx
Normal file
1
awx/ui_next/src/components/DocsLink/index.jsx
Normal file
1
awx/ui_next/src/components/DocsLink/index.jsx
Normal file
@@ -0,0 +1 @@
|
||||
export { default } from './DocsLink';
|
||||
@@ -11,9 +11,12 @@ import {
|
||||
SelectOption,
|
||||
SelectVariant,
|
||||
TextInput,
|
||||
Tooltip,
|
||||
} from '@patternfly/react-core';
|
||||
import { SearchIcon } from '@patternfly/react-icons';
|
||||
import { SearchIcon, QuestionCircleIcon } from '@patternfly/react-icons';
|
||||
import styled from 'styled-components';
|
||||
import { useConfig } from '../../contexts/Config';
|
||||
import getDocsBaseUrl from '../../util/getDocsBaseUrl';
|
||||
|
||||
const AdvancedGroup = styled.div`
|
||||
display: flex;
|
||||
@@ -45,6 +48,7 @@ function AdvancedSearch({
|
||||
const [lookupSelection, setLookupSelection] = useState(null);
|
||||
const [keySelection, setKeySelection] = useState(null);
|
||||
const [searchValue, setSearchValue] = useState('');
|
||||
const config = useConfig();
|
||||
|
||||
const handleAdvancedSearch = e => {
|
||||
// keeps page from fully reloading
|
||||
@@ -262,6 +266,19 @@ function AdvancedSearch({
|
||||
</Button>
|
||||
</div>
|
||||
</InputGroup>
|
||||
<Tooltip
|
||||
content={i18n._(t`Advanced search documentation`)}
|
||||
position="bottom"
|
||||
>
|
||||
<Button
|
||||
component="a"
|
||||
variant="plain"
|
||||
target="_blank"
|
||||
href={`${getDocsBaseUrl(config)}/html/userguide/search_sort.html`}
|
||||
>
|
||||
<QuestionCircleIcon />
|
||||
</Button>
|
||||
</Tooltip>
|
||||
</AdvancedGroup>
|
||||
);
|
||||
}
|
||||
|
||||
@@ -12,6 +12,8 @@ import {
|
||||
HostFilterField,
|
||||
} from './SharedFields';
|
||||
import { required } from '../../../../util/validators';
|
||||
import getDocsBaseUrl from '../../../../util/getDocsBaseUrl';
|
||||
import { useConfig } from '../../../../contexts/Config';
|
||||
|
||||
const AzureSubForm = ({ autoPopulateCredential, i18n }) => {
|
||||
const { setFieldValue } = useFormikContext();
|
||||
@@ -19,6 +21,7 @@ const AzureSubForm = ({ autoPopulateCredential, i18n }) => {
|
||||
name: 'credential',
|
||||
validate: required(i18n._(t`Select a value for this field`), i18n),
|
||||
});
|
||||
const config = useConfig();
|
||||
|
||||
const handleCredentialUpdate = useCallback(
|
||||
value => {
|
||||
@@ -27,8 +30,9 @@ const AzureSubForm = ({ autoPopulateCredential, i18n }) => {
|
||||
[setFieldValue]
|
||||
);
|
||||
|
||||
const pluginLink =
|
||||
'http://docs.ansible.com/ansible-tower/latest/html/userguide/inventories.html#inventory-plugins';
|
||||
const pluginLink = `${getDocsBaseUrl(
|
||||
config
|
||||
)}/html/userguide/inventories.html#inventory-plugins`;
|
||||
const configLink =
|
||||
'https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_inventory.html';
|
||||
|
||||
|
||||
@@ -11,10 +11,13 @@ import {
|
||||
EnabledValueField,
|
||||
HostFilterField,
|
||||
} from './SharedFields';
|
||||
import getDocsBaseUrl from '../../../../util/getDocsBaseUrl';
|
||||
import { useConfig } from '../../../../contexts/Config';
|
||||
|
||||
const EC2SubForm = ({ i18n }) => {
|
||||
const { setFieldValue } = useFormikContext();
|
||||
const [credentialField] = useField('credential');
|
||||
const config = useConfig();
|
||||
|
||||
const handleCredentialUpdate = useCallback(
|
||||
value => {
|
||||
@@ -23,8 +26,9 @@ const EC2SubForm = ({ i18n }) => {
|
||||
[setFieldValue]
|
||||
);
|
||||
|
||||
const pluginLink =
|
||||
'http://docs.ansible.com/ansible-tower/latest/html/userguide/inventories.html#inventory-plugins';
|
||||
const pluginLink = `${getDocsBaseUrl(
|
||||
config
|
||||
)}/html/userguide/inventories.html#inventory-plugins`;
|
||||
const configLink =
|
||||
'https://docs.ansible.com/ansible/latest/collections/amazon/aws/aws_ec2_inventory.html';
|
||||
|
||||
|
||||
@@ -12,6 +12,8 @@ import {
|
||||
SourceVarsField,
|
||||
} from './SharedFields';
|
||||
import { required } from '../../../../util/validators';
|
||||
import getDocsBaseUrl from '../../../../util/getDocsBaseUrl';
|
||||
import { useConfig } from '../../../../contexts/Config';
|
||||
|
||||
const GCESubForm = ({ autoPopulateCredential, i18n }) => {
|
||||
const { setFieldValue } = useFormikContext();
|
||||
@@ -19,6 +21,7 @@ const GCESubForm = ({ autoPopulateCredential, i18n }) => {
|
||||
name: 'credential',
|
||||
validate: required(i18n._(t`Select a value for this field`), i18n),
|
||||
});
|
||||
const config = useConfig();
|
||||
|
||||
const handleCredentialUpdate = useCallback(
|
||||
value => {
|
||||
@@ -27,8 +30,9 @@ const GCESubForm = ({ autoPopulateCredential, i18n }) => {
|
||||
[setFieldValue]
|
||||
);
|
||||
|
||||
const pluginLink =
|
||||
'http://docs.ansible.com/ansible-tower/latest/html/userguide/inventories.html#inventory-plugins';
|
||||
const pluginLink = `${getDocsBaseUrl(
|
||||
config
|
||||
)}/html/userguide/inventories.html#inventory-plugins`;
|
||||
const configLink =
|
||||
'https://docs.ansible.com/ansible/latest/collections/google/cloud/gcp_compute_inventory.html';
|
||||
|
||||
|
||||
@@ -12,6 +12,8 @@ import {
|
||||
HostFilterField,
|
||||
} from './SharedFields';
|
||||
import { required } from '../../../../util/validators';
|
||||
import getDocsBaseUrl from '../../../../util/getDocsBaseUrl';
|
||||
import { useConfig } from '../../../../contexts/Config';
|
||||
|
||||
const OpenStackSubForm = ({ autoPopulateCredential, i18n }) => {
|
||||
const { setFieldValue } = useFormikContext();
|
||||
@@ -19,6 +21,7 @@ const OpenStackSubForm = ({ autoPopulateCredential, i18n }) => {
|
||||
name: 'credential',
|
||||
validate: required(i18n._(t`Select a value for this field`), i18n),
|
||||
});
|
||||
const config = useConfig();
|
||||
|
||||
const handleCredentialUpdate = useCallback(
|
||||
value => {
|
||||
@@ -27,8 +30,9 @@ const OpenStackSubForm = ({ autoPopulateCredential, i18n }) => {
|
||||
[setFieldValue]
|
||||
);
|
||||
|
||||
const pluginLink =
|
||||
'http://docs.ansible.com/ansible-tower/latest/html/userguide/inventories.html#inventory-plugins';
|
||||
const pluginLink = `${getDocsBaseUrl(
|
||||
config
|
||||
)}/html/userguide/inventories.html#inventory-plugins`;
|
||||
const configLink =
|
||||
'https://docs.ansible.com/ansible/latest/collections/openstack/cloud/openstack_inventory.html';
|
||||
|
||||
|
||||
@@ -12,6 +12,8 @@ import {
|
||||
HostFilterField,
|
||||
} from './SharedFields';
|
||||
import { required } from '../../../../util/validators';
|
||||
import getDocsBaseUrl from '../../../../util/getDocsBaseUrl';
|
||||
import { useConfig } from '../../../../contexts/Config';
|
||||
|
||||
const SatelliteSubForm = ({ autoPopulateCredential, i18n }) => {
|
||||
const { setFieldValue } = useFormikContext();
|
||||
@@ -19,6 +21,7 @@ const SatelliteSubForm = ({ autoPopulateCredential, i18n }) => {
|
||||
name: 'credential',
|
||||
validate: required(i18n._(t`Select a value for this field`), i18n),
|
||||
});
|
||||
const config = useConfig();
|
||||
|
||||
const handleCredentialUpdate = useCallback(
|
||||
value => {
|
||||
@@ -27,8 +30,9 @@ const SatelliteSubForm = ({ autoPopulateCredential, i18n }) => {
|
||||
[setFieldValue]
|
||||
);
|
||||
|
||||
const pluginLink =
|
||||
'http://docs.ansible.com/ansible-tower/latest/html/userguide/inventories.html#inventory-plugins';
|
||||
const pluginLink = `${getDocsBaseUrl(
|
||||
config
|
||||
)}/html/userguide/inventories.html#inventory-plugins`;
|
||||
const configLink =
|
||||
'https://docs.ansible.com/ansible/latest/collections/theforeman/foreman/foreman_inventory.html';
|
||||
|
||||
|
||||
@@ -12,6 +12,8 @@ import {
|
||||
SourceVarsField,
|
||||
} from './SharedFields';
|
||||
import { required } from '../../../../util/validators';
|
||||
import getDocsBaseUrl from '../../../../util/getDocsBaseUrl';
|
||||
import { useConfig } from '../../../../contexts/Config';
|
||||
|
||||
const TowerSubForm = ({ autoPopulateCredential, i18n }) => {
|
||||
const { setFieldValue } = useFormikContext();
|
||||
@@ -19,6 +21,7 @@ const TowerSubForm = ({ autoPopulateCredential, i18n }) => {
|
||||
name: 'credential',
|
||||
validate: required(i18n._(t`Select a value for this field`), i18n),
|
||||
});
|
||||
const config = useConfig();
|
||||
|
||||
const handleCredentialUpdate = useCallback(
|
||||
value => {
|
||||
@@ -27,8 +30,9 @@ const TowerSubForm = ({ autoPopulateCredential, i18n }) => {
|
||||
[setFieldValue]
|
||||
);
|
||||
|
||||
const pluginLink =
|
||||
'http://docs.ansible.com/ansible-tower/latest/html/userguide/inventories.html#inventory-plugins';
|
||||
const pluginLink = `${getDocsBaseUrl(
|
||||
config
|
||||
)}/html/userguide/inventories.html#inventory-plugins`;
|
||||
const configLink =
|
||||
'https://docs.ansible.com/ansible/latest/collections/awx/awx/tower_inventory.html';
|
||||
|
||||
|
||||
@@ -12,6 +12,8 @@ import {
|
||||
HostFilterField,
|
||||
} from './SharedFields';
|
||||
import { required } from '../../../../util/validators';
|
||||
import getDocsBaseUrl from '../../../../util/getDocsBaseUrl';
|
||||
import { useConfig } from '../../../../contexts/Config';
|
||||
|
||||
const VMwareSubForm = ({ autoPopulateCredential, i18n }) => {
|
||||
const { setFieldValue } = useFormikContext();
|
||||
@@ -19,6 +21,7 @@ const VMwareSubForm = ({ autoPopulateCredential, i18n }) => {
|
||||
name: 'credential',
|
||||
validate: required(i18n._(t`Select a value for this field`), i18n),
|
||||
});
|
||||
const config = useConfig();
|
||||
|
||||
const handleCredentialUpdate = useCallback(
|
||||
value => {
|
||||
@@ -27,8 +30,9 @@ const VMwareSubForm = ({ autoPopulateCredential, i18n }) => {
|
||||
[setFieldValue]
|
||||
);
|
||||
|
||||
const pluginLink =
|
||||
'http://docs.ansible.com/ansible-tower/latest/html/userguide/inventories.html#inventory-plugins';
|
||||
const pluginLink = `${getDocsBaseUrl(
|
||||
config
|
||||
)}/html/userguide/inventories.html#inventory-plugins`;
|
||||
const configLink =
|
||||
'https://docs.ansible.com/ansible/latest/collections/community/vmware/vmware_vm_inventory_inventory.html';
|
||||
|
||||
|
||||
@@ -12,6 +12,8 @@ import {
|
||||
SourceVarsField,
|
||||
} from './SharedFields';
|
||||
import { required } from '../../../../util/validators';
|
||||
import getDocsBaseUrl from '../../../../util/getDocsBaseUrl';
|
||||
import { useConfig } from '../../../../contexts/Config';
|
||||
|
||||
const VirtualizationSubForm = ({ autoPopulateCredential, i18n }) => {
|
||||
const { setFieldValue } = useFormikContext();
|
||||
@@ -19,6 +21,7 @@ const VirtualizationSubForm = ({ autoPopulateCredential, i18n }) => {
|
||||
name: 'credential',
|
||||
validate: required(i18n._(t`Select a value for this field`), i18n),
|
||||
});
|
||||
const config = useConfig();
|
||||
|
||||
const handleCredentialUpdate = useCallback(
|
||||
value => {
|
||||
@@ -27,8 +30,9 @@ const VirtualizationSubForm = ({ autoPopulateCredential, i18n }) => {
|
||||
[setFieldValue]
|
||||
);
|
||||
|
||||
const pluginLink =
|
||||
'http://docs.ansible.com/ansible-tower/latest/html/userguide/inventories.html#inventory-plugins';
|
||||
const pluginLink = `${getDocsBaseUrl(
|
||||
config
|
||||
)}/html/userguide/inventories.html#inventory-plugins`;
|
||||
const configLink =
|
||||
'https://docs.ansible.com/ansible/latest/collections/ovirt/ovirt/ovirt_inventory.html';
|
||||
|
||||
|
||||
@@ -21,7 +21,7 @@ import {
|
||||
ToolbarToggleGroup,
|
||||
Tooltip,
|
||||
} from '@patternfly/react-core';
|
||||
import { SearchIcon } from '@patternfly/react-icons';
|
||||
import { SearchIcon, QuestionCircleIcon } from '@patternfly/react-icons';
|
||||
|
||||
import AlertModal from '../../../components/AlertModal';
|
||||
import { CardBody as _CardBody } from '../../../components/Card';
|
||||
@@ -47,6 +47,8 @@ import {
|
||||
removeParams,
|
||||
getQSConfig,
|
||||
} from '../../../util/qs';
|
||||
import getDocsBaseUrl from '../../../util/getDocsBaseUrl';
|
||||
import { useConfig } from '../../../contexts/Config';
|
||||
|
||||
const QS_CONFIG = getQSConfig('job_output', {
|
||||
order_by: 'start_line',
|
||||
@@ -280,6 +282,7 @@ function JobOutput({ job, eventRelatedSearchableKeys, eventSearchableKeys }) {
|
||||
const jobSocketCounter = useRef(0);
|
||||
const interval = useRef(null);
|
||||
const history = useHistory();
|
||||
const config = useConfig();
|
||||
const [contentError, setContentError] = useState(null);
|
||||
const [cssMap, setCssMap] = useState({});
|
||||
const [currentlyLoading, setCurrentlyLoading] = useState([]);
|
||||
@@ -730,6 +733,21 @@ function JobOutput({ job, eventRelatedSearchableKeys, eventSearchableKeys }) {
|
||||
) : (
|
||||
renderSearchComponent(i18n)
|
||||
)}
|
||||
<Tooltip
|
||||
content={i18n._(t`Job output documentation`)}
|
||||
position="bottom"
|
||||
>
|
||||
<Button
|
||||
component="a"
|
||||
variant="plain"
|
||||
target="_blank"
|
||||
href={`${getDocsBaseUrl(
|
||||
config
|
||||
)}/html/userguide/jobs.html#standard-out-pane`}
|
||||
>
|
||||
<QuestionCircleIcon />
|
||||
</Button>
|
||||
</Tooltip>
|
||||
</ToolbarItem>
|
||||
</ToolbarToggleGroup>
|
||||
</SearchToolbarContent>
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
import 'styled-components/macro';
|
||||
import React, { useEffect, useRef } from 'react';
|
||||
import { Trans, withI18n } from '@lingui/react';
|
||||
import { withI18n } from '@lingui/react';
|
||||
import { t } from '@lingui/macro';
|
||||
import { useField, useFormikContext } from 'formik';
|
||||
import { Switch, Text } from '@patternfly/react-core';
|
||||
@@ -9,6 +9,8 @@ import {
|
||||
SubFormLayout,
|
||||
} from '../../../components/FormLayout';
|
||||
import CodeEditorField from '../../../components/CodeEditor/CodeEditorField';
|
||||
import { useConfig } from '../../../contexts/Config';
|
||||
import getDocsBaseUrl from '../../../util/getDocsBaseUrl';
|
||||
|
||||
function CustomMessagesSubForm({ defaultMessages, type, i18n }) {
|
||||
const [useCustomField, , useCustomHelpers] = useField('useCustomMessages');
|
||||
@@ -16,6 +18,7 @@ function CustomMessagesSubForm({ defaultMessages, type, i18n }) {
|
||||
const showBodies = ['email', 'pagerduty', 'webhook'].includes(type);
|
||||
|
||||
const { setFieldValue } = useFormikContext();
|
||||
const config = useConfig();
|
||||
const mountedRef = useRef(null);
|
||||
useEffect(
|
||||
function resetToDefaultMessages() {
|
||||
@@ -69,11 +72,9 @@ function CustomMessagesSubForm({ defaultMessages, type, i18n }) {
|
||||
css="margin-bottom: var(--pf-c-content--MarginBottom)"
|
||||
>
|
||||
<small>
|
||||
<Trans>
|
||||
Use custom messages to change the content of notifications sent
|
||||
when a job starts, succeeds, or fails. Use curly braces to
|
||||
access information about the job:{' '}
|
||||
</Trans>
|
||||
{i18n._(t`Use custom messages to change the content of
|
||||
notifications sent when a job starts, succeeds, or fails. Use
|
||||
curly braces to access information about the job:`)}{' '}
|
||||
<code>
|
||||
{'{{'} job_friendly_name {'}}'}
|
||||
</code>
|
||||
@@ -81,23 +82,22 @@ function CustomMessagesSubForm({ defaultMessages, type, i18n }) {
|
||||
<code>
|
||||
{'{{'} url {'}}'}
|
||||
</code>
|
||||
, <Trans>or attributes of the job such as</Trans>{' '}
|
||||
,{' '}
|
||||
<code>
|
||||
{'{{'} job.status {'}}'}
|
||||
</code>
|
||||
.{' '}
|
||||
<Trans>
|
||||
You may apply a number of possible variables in the message.
|
||||
Refer to the{' '}
|
||||
</Trans>{' '}
|
||||
{i18n._(t`You may apply a number of possible variables in the
|
||||
message. For more information, refer to the`)}{' '}
|
||||
<a
|
||||
href="https://docs.ansible.com/ansible-tower/latest/html/userguide/notifications.html#create-custom-notifications"
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
href={`${getDocsBaseUrl(
|
||||
config
|
||||
)}/html/userguide/notifications.html#create-custom-notifications`}
|
||||
>
|
||||
Ansible Tower documentation
|
||||
</a>{' '}
|
||||
<Trans>for more details.</Trans>
|
||||
{i18n._(t`Ansible Tower Documentation.`)}
|
||||
</a>
|
||||
</small>
|
||||
</Text>
|
||||
<FormFullWidthLayout>
|
||||
|
||||
@@ -9,90 +9,97 @@ import {
|
||||
ScmCredentialFormField,
|
||||
ScmTypeOptions,
|
||||
} from './SharedFields';
|
||||
import { useConfig } from '../../../../contexts/Config';
|
||||
import getDocsBaseUrl from '../../../../util/getDocsBaseUrl';
|
||||
|
||||
const GitSubForm = ({
|
||||
i18n,
|
||||
credential,
|
||||
onCredentialSelection,
|
||||
scmUpdateOnLaunch,
|
||||
}) => (
|
||||
<>
|
||||
<UrlFormField
|
||||
i18n={i18n}
|
||||
tooltip={
|
||||
<span>
|
||||
{i18n._(t`Example URLs for GIT Source Control include:`)}
|
||||
<ul css="margin: 10px 0 10px 20px">
|
||||
<li>
|
||||
<code>https://github.com/ansible/ansible.git</code>
|
||||
</li>
|
||||
<li>
|
||||
<code>git@github.com:ansible/ansible.git</code>
|
||||
</li>
|
||||
<li>
|
||||
<code>git://servername.example.com/ansible.git</code>
|
||||
</li>
|
||||
</ul>
|
||||
{i18n._(t`Note: When using SSH protocol for GitHub or
|
||||
}) => {
|
||||
const config = useConfig();
|
||||
return (
|
||||
<>
|
||||
<UrlFormField
|
||||
i18n={i18n}
|
||||
tooltip={
|
||||
<span>
|
||||
{i18n._(t`Example URLs for GIT Source Control include:`)}
|
||||
<ul css="margin: 10px 0 10px 20px">
|
||||
<li>
|
||||
<code>https://github.com/ansible/ansible.git</code>
|
||||
</li>
|
||||
<li>
|
||||
<code>git@github.com:ansible/ansible.git</code>
|
||||
</li>
|
||||
<li>
|
||||
<code>git://servername.example.com/ansible.git</code>
|
||||
</li>
|
||||
</ul>
|
||||
{i18n._(t`Note: When using SSH protocol for GitHub or
|
||||
Bitbucket, enter an SSH key only, do not enter a username
|
||||
(other than git). Additionally, GitHub and Bitbucket do
|
||||
not support password authentication when using SSH. GIT
|
||||
read only protocol (git://) does not use username or
|
||||
password information.`)}
|
||||
</span>
|
||||
}
|
||||
/>
|
||||
<BranchFormField
|
||||
i18n={i18n}
|
||||
label={i18n._(t`Source Control Branch/Tag/Commit`)}
|
||||
/>
|
||||
<FormField
|
||||
id="project-scm-refspec"
|
||||
label={i18n._(t`Source Control Refspec`)}
|
||||
name="scm_refspec"
|
||||
type="text"
|
||||
tooltipMaxWidth="400px"
|
||||
tooltip={
|
||||
<span>
|
||||
{i18n._(t`A refspec to fetch (passed to the Ansible git
|
||||
</span>
|
||||
}
|
||||
/>
|
||||
<BranchFormField
|
||||
i18n={i18n}
|
||||
label={i18n._(t`Source Control Branch/Tag/Commit`)}
|
||||
/>
|
||||
<FormField
|
||||
id="project-scm-refspec"
|
||||
label={i18n._(t`Source Control Refspec`)}
|
||||
name="scm_refspec"
|
||||
type="text"
|
||||
tooltipMaxWidth="400px"
|
||||
tooltip={
|
||||
<span>
|
||||
{i18n._(t`A refspec to fetch (passed to the Ansible git
|
||||
module). This parameter allows access to references via
|
||||
the branch field not otherwise available.`)}
|
||||
<br />
|
||||
<br />
|
||||
{i18n._(t`Note: This field assumes the remote name is "origin".`)}
|
||||
<br />
|
||||
<br />
|
||||
{i18n._(t`Examples include:`)}
|
||||
<ul css={{ margin: '10px 0 10px 20px' }}>
|
||||
<li>
|
||||
<code>refs/*:refs/remotes/origin/*</code>
|
||||
</li>
|
||||
<li>
|
||||
<code>refs/pull/62/head:refs/remotes/origin/pull/62/head</code>
|
||||
</li>
|
||||
</ul>
|
||||
{i18n._(t`The first fetches all references. The second
|
||||
<br />
|
||||
<br />
|
||||
{i18n._(t`Note: This field assumes the remote name is "origin".`)}
|
||||
<br />
|
||||
<br />
|
||||
{i18n._(t`Examples include:`)}
|
||||
<ul css={{ margin: '10px 0 10px 20px' }}>
|
||||
<li>
|
||||
<code>refs/*:refs/remotes/origin/*</code>
|
||||
</li>
|
||||
<li>
|
||||
<code>refs/pull/62/head:refs/remotes/origin/pull/62/head</code>
|
||||
</li>
|
||||
</ul>
|
||||
{i18n._(t`The first fetches all references. The second
|
||||
fetches the Github pull request number 62, in this example
|
||||
the branch needs to be "pull/62/head".`)}
|
||||
<br />
|
||||
<br />
|
||||
{i18n._(t`For more information, refer to the`)}{' '}
|
||||
<a
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
href="https://docs.ansible.com/ansible-tower/latest/html/userguide/projects.html#manage-playbooks-using-source-control"
|
||||
>
|
||||
{i18n._(t`Ansible Tower Documentation.`)}
|
||||
</a>
|
||||
</span>
|
||||
}
|
||||
/>
|
||||
<ScmCredentialFormField
|
||||
credential={credential}
|
||||
onCredentialSelection={onCredentialSelection}
|
||||
/>
|
||||
<ScmTypeOptions scmUpdateOnLaunch={scmUpdateOnLaunch} />
|
||||
</>
|
||||
);
|
||||
<br />
|
||||
<br />
|
||||
{i18n._(t`For more information, refer to the`)}{' '}
|
||||
<a
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
href={`${getDocsBaseUrl(
|
||||
config
|
||||
)}/html/userguide/projects.html#manage-playbooks-using-source-control`}
|
||||
>
|
||||
{i18n._(t`Ansible Tower Documentation.`)}
|
||||
</a>
|
||||
</span>
|
||||
}
|
||||
/>
|
||||
<ScmCredentialFormField
|
||||
credential={credential}
|
||||
onCredentialSelection={onCredentialSelection}
|
||||
/>
|
||||
<ScmTypeOptions scmUpdateOnLaunch={scmUpdateOnLaunch} />
|
||||
</>
|
||||
);
|
||||
};
|
||||
|
||||
export default withI18n()(GitSubForm);
|
||||
|
||||
@@ -26,6 +26,8 @@ import JobTemplatesList from './JobTemplatesList';
|
||||
import ProjectsList from './ProjectsList';
|
||||
import WorkflowJobTemplatesList from './WorkflowJobTemplatesList';
|
||||
import FormField from '../../../../../../components/FormField';
|
||||
import getDocsBaseUrl from '../../../../../../util/getDocsBaseUrl';
|
||||
import { useConfig } from '../../../../../../contexts/Config';
|
||||
|
||||
const NodeTypeErrorAlert = styled(Alert)`
|
||||
margin-bottom: 20px;
|
||||
@@ -59,6 +61,7 @@ function NodeTypeStep({ i18n }) {
|
||||
const [convergenceField, , convergenceFieldHelpers] = useField('convergence');
|
||||
|
||||
const [isConvergenceOpen, setIsConvergenceOpen] = useState(false);
|
||||
const config = useConfig();
|
||||
|
||||
const isValid = !approvalNameMeta.touched || !approvalNameMeta.error;
|
||||
return (
|
||||
@@ -212,7 +215,9 @@ function NodeTypeStep({ i18n }) {
|
||||
t`Preconditions for running this node when there are multiple parents. Refer to the`
|
||||
)}{' '}
|
||||
<a
|
||||
href="https://docs.ansible.com/ansible-tower/latest/html/userguide/workflow_templates.html#convergence-node"
|
||||
href={`${getDocsBaseUrl(
|
||||
config
|
||||
)}/html/userguide/workflow_templates.html#convergence-node`}
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
>
|
||||
|
||||
@@ -23,6 +23,8 @@ import {
|
||||
WorkflowDispatchContext,
|
||||
WorkflowStateContext,
|
||||
} from '../../../contexts/Workflow';
|
||||
import getDocsBaseUrl from '../../../util/getDocsBaseUrl';
|
||||
import { useConfig } from '../../../contexts/Config';
|
||||
|
||||
const Badge = styled(PFBadge)`
|
||||
align-items: center;
|
||||
@@ -47,9 +49,6 @@ const ActionButton = styled(Button)`
|
||||
`;
|
||||
ActionButton.displayName = 'ActionButton';
|
||||
|
||||
const DOCLINK =
|
||||
'https://docs.ansible.com/ansible-tower/latest/html/userguide/workflow_templates.html#ug-wf-editor';
|
||||
|
||||
function VisualizerToolbar({
|
||||
i18n,
|
||||
onClose,
|
||||
@@ -59,8 +58,8 @@ function VisualizerToolbar({
|
||||
readOnly,
|
||||
}) {
|
||||
const dispatch = useContext(WorkflowDispatchContext);
|
||||
|
||||
const { nodes, showLegend, showTools } = useContext(WorkflowStateContext);
|
||||
const config = useConfig();
|
||||
|
||||
const totalNodes = nodes.reduce((n, node) => n + !node.isDeleted, 0) - 1;
|
||||
|
||||
@@ -113,7 +112,9 @@ function VisualizerToolbar({
|
||||
variant="plain"
|
||||
component="a"
|
||||
target="_blank"
|
||||
href={DOCLINK}
|
||||
href={`${getDocsBaseUrl(
|
||||
config
|
||||
)}/html/userguide/workflow_templates.html#ug-wf-editor`}
|
||||
>
|
||||
<BookIcon />
|
||||
</ActionButton>
|
||||
|
||||
8
awx/ui_next/src/util/getDocsBaseUrl.js
Normal file
8
awx/ui_next/src/util/getDocsBaseUrl.js
Normal file
@@ -0,0 +1,8 @@
|
||||
export default function getDocsBaseUrl(config) {
|
||||
let version = 'latest';
|
||||
const licenseType = config?.license_info?.license_type;
|
||||
if (licenseType && licenseType !== 'open') {
|
||||
version = config?.version ? config.version.split('-')[0] : 'latest';
|
||||
}
|
||||
return `https://docs.ansible.com/ansible-tower/${version}`;
|
||||
}
|
||||
44
awx/ui_next/src/util/getDocsBaseUrl.test.js
Normal file
44
awx/ui_next/src/util/getDocsBaseUrl.test.js
Normal file
@@ -0,0 +1,44 @@
|
||||
import getDocsBaseUrl from './getDocsBaseUrl';
|
||||
|
||||
describe('getDocsBaseUrl', () => {
|
||||
it('should return latest version for open license', () => {
|
||||
const result = getDocsBaseUrl({
|
||||
license_info: {
|
||||
license_type: 'open',
|
||||
},
|
||||
version: '18.0.0',
|
||||
});
|
||||
|
||||
expect(result).toEqual('https://docs.ansible.com/ansible-tower/latest');
|
||||
});
|
||||
|
||||
it('should return current version for enterprise license', () => {
|
||||
const result = getDocsBaseUrl({
|
||||
license_info: {
|
||||
license_type: 'enterprise',
|
||||
},
|
||||
version: '4.0.0',
|
||||
});
|
||||
|
||||
expect(result).toEqual('https://docs.ansible.com/ansible-tower/4.0.0');
|
||||
});
|
||||
|
||||
it('should strip version info after hyphen', () => {
|
||||
const result = getDocsBaseUrl({
|
||||
license_info: {
|
||||
license_type: 'enterprise',
|
||||
},
|
||||
version: '4.0.0-beta',
|
||||
});
|
||||
|
||||
expect(result).toEqual('https://docs.ansible.com/ansible-tower/4.0.0');
|
||||
});
|
||||
|
||||
it('should return latest version if license info missing', () => {
|
||||
const result = getDocsBaseUrl({
|
||||
version: '18.0.0',
|
||||
});
|
||||
|
||||
expect(result).toEqual('https://docs.ansible.com/ansible-tower/latest');
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user