chore: update documentation links (#3144)

This commit is contained in:
Opender Singh 2021-03-05 02:33:46 +13:00 committed by GitHub
parent 23c05c4bb9
commit d68509e81d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 17 additions and 18 deletions

View File

@ -4,7 +4,12 @@ function insomniaDocs(slug: string): string {
} }
export const docsBase = insomniaDocs('/'); export const docsBase = insomniaDocs('/');
export const docsGitSync = insomniaDocs('/article/96-git-sync'); export const docsGitSync = insomniaDocs('/article/193-git-sync');
export const docsTemplateTags = insomniaDocs('/article/171-template-tags');
export const docsVersionControl = insomniaDocs('/article/165-version-control-sync');
export const docsPlugins = insomniaDocs('/article/173-plugins');
export const docsImportExport = insomniaDocs('/article/172-importing-and-exporting-data');
export const docsGitAccessToken = { export const docsGitAccessToken = {
github: github:
'https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token', 'https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token',

View File

@ -22,6 +22,7 @@ import * as session from '../../../account/session';
import PromptButton from '../base/prompt-button'; import PromptButton from '../base/prompt-button';
import * as db from '../../../common/database'; import * as db from '../../../common/database';
import * as models from '../../../models'; import * as models from '../../../models';
import { docsVersionControl } from '../../../common/documentation';
// Stop refreshing if user hasn't been active in this long // Stop refreshing if user hasn't been active in this long
const REFRESH_USER_ACTIVITY = 1000 * 60 * 10; const REFRESH_USER_ACTIVITY = 1000 * 60 * 10;
@ -453,7 +454,7 @@ class SyncDropdown extends React.PureComponent<Props, State> {
Insomnia Sync{' '} Insomnia Sync{' '}
<HelpTooltip> <HelpTooltip>
Sync and collaborate on workspaces{' '} Sync and collaborate on workspaces{' '}
<Link href="https://support.insomnia.rest/article/67-version-control"> <Link href={docsVersionControl}>
<span className="no-wrap"> <span className="no-wrap">
<br /> <br />
Documentation <i className="fa fa-external-link" /> Documentation <i className="fa fa-external-link" />

View File

@ -8,6 +8,7 @@ import ModalBody from '../base/modal-body';
import ModalHeader from '../base/modal-header'; import ModalHeader from '../base/modal-header';
import { showModal } from './index'; import { showModal } from './index';
import Link from '../base/link'; import Link from '../base/link';
import { docsTemplateTags } from '../../../common/documentation';
@autoBindMethodsForReact(AUTOBIND_CFG) @autoBindMethodsForReact(AUTOBIND_CFG)
class RequestRenderErrorModal extends PureComponent { class RequestRenderErrorModal extends PureComponent {
@ -58,10 +59,7 @@ class RequestRenderErrorModal extends PureComponent {
Adjust Render Settings Adjust Render Settings
</button> </button>
)} )}
<Link <Link button href={docsTemplateTags} className="btn btn--clicky">
button
href="https://support.insomnia.rest/article/40-template-tags"
className="btn btn--clicky">
Templating Documentation <i className="fa fa-external-link" /> Templating Documentation <i className="fa fa-external-link" />
</Link> </Link>
</div> </div>

View File

@ -21,6 +21,7 @@ import type { Environment } from '../../../models/environment';
import * as db from '../../../common/database'; import * as db from '../../../common/database';
import HelpTooltip from '../help-tooltip'; import HelpTooltip from '../help-tooltip';
import Tooltip from '../tooltip'; import Tooltip from '../tooltip';
import { docsTemplateTags } from '../../../common/documentation';
const ROOT_ENVIRONMENT_NAME = 'Base Environment'; const ROOT_ENVIRONMENT_NAME = 'Base Environment';
@ -535,10 +536,7 @@ class WorkspaceEnvironmentsEditModal extends React.PureComponent<Props, State> {
<ModalFooter> <ModalFooter>
<div className="margin-left italic txt-sm tall"> <div className="margin-left italic txt-sm tall">
* Environment data can be used for&nbsp; * Environment data can be used for&nbsp;
<Link href="https://support.insomnia.rest/article/40-template-tags"> <Link href={docsTemplateTags}>Nunjucks Templating</Link> in your requests
Nunjucks Templating
</Link>{' '}
in your requests
</div> </div>
<button className="btn" disabled={!isValid} onClick={this.hide}> <button className="btn" disabled={!isValid} onClick={this.hide}>
Done Done

View File

@ -6,6 +6,7 @@ import { Dropdown, DropdownButton, DropdownDivider, DropdownItem } from '../base
import Link from '../base/link'; import Link from '../base/link';
import { showPrompt } from '../modals/index'; import { showPrompt } from '../modals/index';
import { strings } from '../../../common/strings'; import { strings } from '../../../common/strings';
import { docsImportExport } from '../../../common/documentation';
@autoBindMethodsForReact(AUTOBIND_CFG) @autoBindMethodsForReact(AUTOBIND_CFG)
class ImportExport extends PureComponent { class ImportExport extends PureComponent {
@ -45,11 +46,7 @@ class ImportExport extends PureComponent {
<strong>Insomnia, Postman v2, HAR, Curl, Swagger, OpenAPI v3</strong>) <strong>Insomnia, Postman v2, HAR, Curl, Swagger, OpenAPI v3</strong>)
</p> </p>
<p> <p>
Don't see your format here?{' '} Don't see your format here? <Link href={docsImportExport}>Add Your Own</Link>.
<Link href="https://support.insomnia.rest/article/52-importing-and-exporting-data">
Add Your Own
</Link>
.
</p> </p>
<div className="pad-top"> <div className="pad-top">
<Dropdown outline> <Dropdown outline>

View File

@ -22,6 +22,7 @@ import type { PluginConfig, Settings } from '../../../models/settings';
import { Button, ToggleSwitch } from 'insomnia-components'; import { Button, ToggleSwitch } from 'insomnia-components';
import { createPlugin } from '../../../plugins/create'; import { createPlugin } from '../../../plugins/create';
import { showAlert, showPrompt } from '../modals'; import { showAlert, showPrompt } from '../modals';
import { docsPlugins } from '../../../common/documentation';
type State = { type State = {
plugins: Array<Plugin>, plugins: Array<Plugin>,
@ -137,7 +138,7 @@ class Plugins extends React.PureComponent<Props, State> {
'0.0.1', '0.0.1',
[ [
'// For help writing plugins, visit the documentation to get started:', '// For help writing plugins, visit the documentation to get started:',
'// https://support.insomnia.rest/article/26-plugins', `// ${docsPlugins}`,
'', '',
'// TODO: Add plugin code here...', '// TODO: Add plugin code here...',
].join('\n'), ].join('\n'),
@ -225,8 +226,7 @@ class Plugins extends React.PureComponent<Props, State> {
<div> <div>
<p className="notice info no-margin-top"> <p className="notice info no-margin-top">
Plugins is still an experimental feature. See{' '} Plugins is still an experimental feature. See{' '}
<Link href="https://support.insomnia.rest/article/26-plugins">Documentation</Link> for <Link href={docsPlugins}>Documentation</Link> for more info.
more info.
</p> </p>
{plugins.length === 0 ? ( {plugins.length === 0 ? (
<div className="text-center faint italic pad">No Plugins Added</div> <div className="text-center faint italic pad">No Plugins Added</div>