mirror of
https://github.com/balena-io/balena-cli.git
synced 2025-05-02 00:53:06 +00:00
docs: Add references to the masterclasses in the CLI help and README
Change-type: patch
This commit is contained in:
parent
a4fd7d6118
commit
2bf59530c4
12
README.md
12
README.md
@ -139,12 +139,14 @@ The full CLI command reference is available [on the web](https://www.balena.io/d
|
|||||||
|
|
||||||
## Support, FAQ and troubleshooting
|
## Support, FAQ and troubleshooting
|
||||||
|
|
||||||
If you come across any problems or would like to get in touch:
|
To learn more, troubleshoot issues, or to contact us for support:
|
||||||
|
|
||||||
* Check our [FAQ / troubleshooting document](https://github.com/balena-io/balena-cli/blob/master/TROUBLESHOOTING.md).
|
* Check the [masterclass tutorials](https://www.balena.io/docs/learn/more/masterclasses/overview/)
|
||||||
* Ask us a question through the [balenaCloud forum](https://forums.balena.io/c/balena-cloud).
|
* Check our [FAQ / troubleshooting document](https://github.com/balena-io/balena-cli/blob/master/TROUBLESHOOTING.md)
|
||||||
* For bug reports or feature requests,
|
* Ask us a question through the [balenaCloud forum](https://forums.balena.io/c/balena-cloud)
|
||||||
[have a look at the GitHub issues or create a new one](https://github.com/balena-io/balena-cli/issues/).
|
|
||||||
|
For CLI bug reports or feature requests, check the
|
||||||
|
[CLI GitHub issues](https://github.com/balena-io/balena-cli/issues/).
|
||||||
|
|
||||||
## Deprecation policy
|
## Deprecation policy
|
||||||
|
|
||||||
|
@ -127,12 +127,14 @@ address like `192.168.1.2`.
|
|||||||
|
|
||||||
## Support, FAQ and troubleshooting
|
## Support, FAQ and troubleshooting
|
||||||
|
|
||||||
If you come across any problems or would like to get in touch:
|
To learn more, troubleshoot issues, or to contact us for support:
|
||||||
|
|
||||||
* Check our [FAQ / troubleshooting document](https://github.com/balena-io/balena-cli/blob/master/TROUBLESHOOTING.md).
|
* Check the [masterclass tutorials](https://www.balena.io/docs/learn/more/masterclasses/overview/)
|
||||||
* Ask us a question through the [balenaCloud forum](https://forums.balena.io/c/balena-cloud).
|
* Check our [FAQ / troubleshooting document](https://github.com/balena-io/balena-cli/blob/master/TROUBLESHOOTING.md)
|
||||||
* For bug reports or feature requests,
|
* Ask us a question through the [balenaCloud forum](https://forums.balena.io/c/balena-cloud)
|
||||||
[have a look at the GitHub issues or create a new one](https://github.com/balena-io/balena-cli/issues/).
|
|
||||||
|
For CLI bug reports or feature requests, check the
|
||||||
|
[CLI GitHub issues](https://github.com/balena-io/balena-cli/issues/).
|
||||||
|
|
||||||
## Deprecation policy
|
## Deprecation policy
|
||||||
|
|
||||||
|
30
lib/help.ts
30
lib/help.ts
@ -1,3 +1,19 @@
|
|||||||
|
/**
|
||||||
|
* @license
|
||||||
|
* Copyright 2017-2020 Balena Ltd.
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*/
|
||||||
import Help from '@oclif/plugin-help';
|
import Help from '@oclif/plugin-help';
|
||||||
import * as indent from 'indent-string';
|
import * as indent from 'indent-string';
|
||||||
import { getChalk } from './utils/lazy';
|
import { getChalk } from './utils/lazy';
|
||||||
@ -123,16 +139,10 @@ export default class BalenaHelp extends Help {
|
|||||||
console.log(' --help, -h');
|
console.log(' --help, -h');
|
||||||
console.log(' --debug\n');
|
console.log(' --debug\n');
|
||||||
|
|
||||||
console.log(
|
const {
|
||||||
`For help, visit our support forums: ${chalk.grey(
|
reachingOut,
|
||||||
'https://forums.balena.io',
|
} = require('./utils/messages') as typeof import('./utils/messages');
|
||||||
)}`,
|
console.log(reachingOut);
|
||||||
);
|
|
||||||
console.log(
|
|
||||||
`For bug reports or feature requests, see: ${chalk.grey(
|
|
||||||
'https://github.com/balena-io/balena-cli/issues/',
|
|
||||||
)}\n`,
|
|
||||||
);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
protected formatCommands(commands: any[]): string {
|
protected formatCommands(commands: any[]): string {
|
||||||
|
@ -16,21 +16,15 @@
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
export const reachingOut = `\
|
export const reachingOut = `\
|
||||||
If you need help, or just want to say hi, don't hesitate in reaching out
|
For further help or support, visit:
|
||||||
through our discussion and support forums at https://forums.balena.io
|
https://www.balena.io/docs/reference/balena-cli/#support-faq-and-troubleshooting
|
||||||
|
|
||||||
For bug reports or feature requests, have a look at the GitHub issues or
|
|
||||||
create a new one at: https://github.com/balena-io/balena-cli/issues/\
|
|
||||||
`;
|
`;
|
||||||
|
|
||||||
const debugHint = `\
|
const debugHint = `\
|
||||||
Additional information may be available with the \`--debug\` flag.
|
Additional information may be available with the \`--debug\` flag.
|
||||||
\n`;
|
\n`;
|
||||||
|
|
||||||
export const help = `\
|
export const help = reachingOut;
|
||||||
For help, visit our support forums: https://forums.balena.io
|
|
||||||
For bug reports or feature requests, see: https://github.com/balena-io/balena-cli/issues/
|
|
||||||
`;
|
|
||||||
|
|
||||||
// Note that the value of process.env.DEBUG may change after the --debug flag
|
// Note that the value of process.env.DEBUG may change after the --debug flag
|
||||||
// is parsed, so its evaluation cannot happen at module loading time.
|
// is parsed, so its evaluation cannot happen at module loading time.
|
||||||
|
@ -19,6 +19,7 @@ import { expect } from 'chai';
|
|||||||
|
|
||||||
import { BalenaAPIMock } from '../balena-api-mock';
|
import { BalenaAPIMock } from '../balena-api-mock';
|
||||||
import { cleanOutput, runCommand } from '../helpers';
|
import { cleanOutput, runCommand } from '../helpers';
|
||||||
|
import * as messages from '../../build/utils/messages';
|
||||||
|
|
||||||
const SIMPLE_HELP = `
|
const SIMPLE_HELP = `
|
||||||
USAGE
|
USAGE
|
||||||
@ -103,10 +104,7 @@ GLOBAL OPTIONS
|
|||||||
|
|
||||||
`;
|
`;
|
||||||
|
|
||||||
const ONLINE_RESOURCES = `
|
const ONLINE_RESOURCES = messages.reachingOut;
|
||||||
For help, visit our support forums: https://forums.balena.io
|
|
||||||
For bug reports or feature requests, see: https://github.com/balena-io/balena-cli/issues/
|
|
||||||
`;
|
|
||||||
|
|
||||||
describe.skip('balena help', function () {
|
describe.skip('balena help', function () {
|
||||||
let api: BalenaAPIMock;
|
let api: BalenaAPIMock;
|
||||||
|
Loading…
x
Reference in New Issue
Block a user