Skip to content
This repository has been archived by the owner on Jun 6, 2024. It is now read-only.

Add help info #4950

Merged
merged 4 commits into from
Oct 14, 2020
Merged

Add help info #4950

merged 4 commits into from
Oct 14, 2020

Conversation

debuggy
Copy link
Contributor

@debuggy debuggy commented Oct 12, 2020

No description provided.

@debuggy debuggy requested a review from hzy46 October 12, 2020 06:44
@debuggy debuggy mentioned this pull request Oct 12, 2020
31 tasks
@coveralls
Copy link

coveralls commented Oct 12, 2020

Coverage Status

Coverage remained the same at 34.383% when pulling 74e3118 on mintao/help-info into 1163cb8 on master.

parameters:
'Parameters are key-value pairs that you could save your frequently used values and reference them in command section by their keys.',
secrets: `Secrets are used to store sensitive data. The value will be masked and won't be seen by other users.`,
'https://openpai.readthedocs.io/en/latest/manual/cluster-user/quick-start.html',
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be https://openpai.readthedocs.io/en/latest/manual/cluster-user/how-to-use-advanced-job-settings.html#parameters-and-secrets

'Parameters are key-value pairs that you could save your frequently used values and reference them in command section by their keys.',
secrets: `Secrets are used to store sensitive data. The value will be masked and won't be seen by other users.`,
'https://openpai.readthedocs.io/en/latest/manual/cluster-user/quick-start.html',
secrets: `https://openpai.readthedocs.io/en/latest/manual/cluster-user/quick-start.html`,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be https://openpai.readthedocs.io/en/latest/manual/cluster-user/how-to-use-advanced-job-settings.html#parameters-and-secrets

@hzy46
Copy link
Contributor

hzy46 commented Oct 13, 2020

image

The alignment seems to have problem. The icon should be in the right-top corner?

@debuggy
Copy link
Contributor Author

debuggy commented Oct 13, 2020

image

The alignment seems to have problem. The icon should be in the right-top corner?

Updated. Could you help check the link of each info icon?

@hzy46
Copy link
Contributor

hzy46 commented Oct 13, 2020

image
The alignment seems to have problem. The icon should be in the right-top corner?

Updated. Could you help check the link of each info icon?

The links for parameter and secrets are wrong. Other links are OK.

@debuggy
Copy link
Contributor Author

debuggy commented Oct 13, 2020

image
The alignment seems to have problem. The icon should be in the right-top corner?

Updated. Could you help check the link of each info icon?

The links for parameter and secrets are wrong. Other links are OK.

More links are added in constants after this update

@hzy46
Copy link
Contributor

hzy46 commented Oct 13, 2020

Checked. All links are correct now.

@debuggy debuggy merged commit f5bc5b2 into master Oct 14, 2020
@debuggy debuggy deleted the mintao/help-info branch November 26, 2020 07:24
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants