-
Notifications
You must be signed in to change notification settings - Fork 3.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adds popover help text to project details, and unifies those strings …
…(used in the form and the details view) into 1 file (#12039)
- Loading branch information
1 parent
3a1268d
commit ae7960e
Showing
14 changed files
with
356 additions
and
264 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,142 @@ | ||
| import React from 'react'; | ||
| import { t } from '@lingui/macro'; | ||
| import getDocsBaseUrl from 'util/getDocsBaseUrl'; | ||
| import { useConfig } from 'contexts/Config'; | ||
| import useBrandName from 'hooks/useBrandName'; | ||
|
|
||
| const ProjectHelpTextStrings = () => ({ | ||
| executionEnvironment: t`The execution environment that will be used for jobs that use this project. This will be used as fallback when an execution environment has not been explicitly assigned at the job template or workflow level.`, | ||
| projectBasePath: ( | ||
| <span> | ||
| {t`Base path used for locating playbooks. Directories | ||
| found inside this path will be listed in the playbook directory drop-down. | ||
| Together the base path and selected playbook directory provide the full | ||
| path used to locate playbooks.`} | ||
| <br /> | ||
| <br /> | ||
| {t`Change PROJECTS_ROOT when deploying | ||
| ${useBrandName()} to change this location.`} | ||
| </span> | ||
| ), | ||
| projectLocalPath: t`Select from the list of directories found in | ||
| the Project Base Path. Together the base path and the playbook | ||
| directory provide the full path used to locate playbooks.`, | ||
| githubSourceControlUrl: ( | ||
| <span> | ||
| {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> | ||
| {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> | ||
| ), | ||
| svnSourceControlUrl: ( | ||
| <span> | ||
| {t`Example URLs for Subversion Source Control include:`} | ||
| <ul css={{ margin: '10px 0 10px 20px' }}> | ||
| <li> | ||
| <code>https://github.com/ansible/ansible</code> | ||
| </li> | ||
| <li> | ||
| <code>svn://servername.example.com/path</code> | ||
| </li> | ||
| <li> | ||
| <code>svn+ssh://servername.example.com/path</code> | ||
| </li> | ||
| </ul> | ||
| </span> | ||
| ), | ||
| syncButtonDisabled: t`This project is currently on sync and cannot be clicked until sync process completed`, | ||
| archiveUrl: ( | ||
| <span> | ||
| {t`Example URLs for Remote Archive Source Control include:`} | ||
| <ul css={{ margin: '10px 0 10px 20px' }}> | ||
| <li> | ||
| <code>https://github.com/username/project/archive/v0.0.1.tar.gz</code> | ||
| </li> | ||
| <li> | ||
| <code>https://github.com/username/project/archive/v0.0.2.zip</code> | ||
| </li> | ||
| </ul> | ||
| </span> | ||
| ), | ||
|
|
||
| sourceControlRefspec: ( | ||
| <span> | ||
| {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 /> | ||
| {t`Note: This field assumes the remote name is "origin".`} | ||
| <br /> | ||
| <br /> | ||
| {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> | ||
| {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 /> | ||
| {t`For more information, refer to the`}{' '} | ||
| <a | ||
| target="_blank" | ||
| rel="noopener noreferrer" | ||
| href={`${getDocsBaseUrl( | ||
| useConfig() | ||
| )}/html/userguide/projects.html#manage-playbooks-using-source-control`} | ||
| > | ||
| {t`Documentation.`} | ||
| </a> | ||
| </span> | ||
| ), | ||
| branchFormField: t`Branch to checkout. In addition to branches, | ||
| you can input tags, commit hashes, and arbitrary refs. Some | ||
| commit hashes and refs may not be available unless you also | ||
| provide a custom refspec.`, | ||
| options: { | ||
| clean: t`Remove any local modifications prior to performing an update.`, | ||
| delete: t`Delete the local repository in its entirety prior to | ||
| performing an update. Depending on the size of the | ||
| repository this may significantly increase the amount | ||
| of time required to complete an update.`, | ||
| trackSubModules: t`Submodules will track the latest commit on | ||
| their master branch (or other branch specified in | ||
| .gitmodules). If no, submodules will be kept at | ||
| the revision specified by the main project. | ||
| This is equivalent to specifying the --remote | ||
| flag to git submodule update.`, | ||
| updateOnLaunch: t`Each time a job runs using this project, update the | ||
| revision of the project prior to starting the job.`, | ||
| allowBranchOverride: t`Allow changing the Source Control branch or revision in a job | ||
| template that uses this project.`, | ||
| cacheTimeout: t`Time in seconds to consider a project | ||
| to be current. During job runs and callbacks the task | ||
| system will evaluate the timestamp of the latest project | ||
| update. If it is older than Cache Timeout, it is not | ||
| considered current, and a new project update will be | ||
| performed.`, | ||
| }, | ||
| }); | ||
|
|
||
| export default ProjectHelpTextStrings; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.