Update links to CLI docs in code comments, messages, and readme
This commit is contained in:
parent
d1e8537b33
commit
a60120477c
|
@ -36,7 +36,7 @@ Show off your Terraform knowledge by passing a certification exam. Visit the [ce
|
||||||
Developing Terraform
|
Developing Terraform
|
||||||
--------------------
|
--------------------
|
||||||
|
|
||||||
This repository contains only Terraform core, which includes the command line interface and the main graph engine. Providers are implemented as plugins that each have their own repository in [the `terraform-providers` organization](https://github.com/terraform-providers) on GitHub. Instructions for developing each provider are in the associated README file. For more information, see [the provider development overview](https://www.terraform.io/docs/plugins/provider.html).
|
This repository contains only Terraform core, which includes the command line interface and the main graph engine. Providers are implemented as plugins, and Terraform can automatically download providers that are published on [the Terraform Registry](https://registry.terraform.io). HashiCorp develops some providers, and others are developed by other organizations. For more information, see [Extending Terraform](https://www.terraform.io/docs/extend/index.html).
|
||||||
|
|
||||||
To learn more about compiling Terraform and contributing suggested changes, please refer to [the contributing guide](.github/CONTRIBUTING.md).
|
To learn more about compiling Terraform and contributing suggested changes, please refer to [the contributing guide](.github/CONTRIBUTING.md).
|
||||||
|
|
||||||
|
|
|
@ -343,7 +343,7 @@ func (c *ImportCommand) Synopsis() string {
|
||||||
}
|
}
|
||||||
|
|
||||||
const importCommandInvalidAddressReference = `For information on valid syntax, see:
|
const importCommandInvalidAddressReference = `For information on valid syntax, see:
|
||||||
https://www.terraform.io/docs/internals/resource-addressing.html`
|
https://www.terraform.io/docs/cli/state/resource-addressing.html`
|
||||||
|
|
||||||
const importCommandMissingResourceFmt = `[reset][bold][red]Error:[reset][bold] resource address %q does not exist in the configuration.[reset]
|
const importCommandMissingResourceFmt = `[reset][bold][red]Error:[reset][bold] resource address %q does not exist in the configuration.[reset]
|
||||||
|
|
||||||
|
|
|
@ -714,7 +714,7 @@ func (c *InitCommand) getProviders(config *configs.Config, state *states.State,
|
||||||
if thirdPartySigned {
|
if thirdPartySigned {
|
||||||
c.Ui.Info(fmt.Sprintf("\nPartner and community providers are signed by their developers.\n" +
|
c.Ui.Info(fmt.Sprintf("\nPartner and community providers are signed by their developers.\n" +
|
||||||
"If you'd like to know more about provider signing, you can read about it here:\n" +
|
"If you'd like to know more about provider signing, you can read about it here:\n" +
|
||||||
"https://www.terraform.io/docs/plugins/signing.html"))
|
"https://www.terraform.io/docs/cli/plugins/signing.html"))
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
HashPackageFailure: func(provider addrs.Provider, version getproviders.Version, err error) {
|
HashPackageFailure: func(provider addrs.Provider, version getproviders.Version, err error) {
|
||||||
|
@ -968,7 +968,7 @@ Options:
|
||||||
-no-color If specified, output won't contain any color.
|
-no-color If specified, output won't contain any color.
|
||||||
|
|
||||||
-plugin-dir Directory containing plugin binaries. This overrides all
|
-plugin-dir Directory containing plugin binaries. This overrides all
|
||||||
default search paths for plugins, and prevents the
|
default search paths for plugins, and prevents the
|
||||||
automatic installation of plugins. This flag can be used
|
automatic installation of plugins. This flag can be used
|
||||||
multiple times.
|
multiple times.
|
||||||
|
|
||||||
|
|
|
@ -103,7 +103,7 @@ func initCommands(
|
||||||
|
|
||||||
// The command list is included in the terraform -help
|
// The command list is included in the terraform -help
|
||||||
// output, which is in turn included in the docs at
|
// output, which is in turn included in the docs at
|
||||||
// website/docs/commands/index.html.markdown; if you
|
// website/docs/cli/commands/index.html.markdown; if you
|
||||||
// add, remove or reclassify commands then consider updating
|
// add, remove or reclassify commands then consider updating
|
||||||
// that to match.
|
// that to match.
|
||||||
|
|
||||||
|
|
|
@ -4,7 +4,7 @@ This directory contains some documentation about the Terraform Core codebase,
|
||||||
aimed at readers who are interested in making code contributions.
|
aimed at readers who are interested in making code contributions.
|
||||||
|
|
||||||
If you're looking for information on _using_ Terraform, please instead refer
|
If you're looking for information on _using_ Terraform, please instead refer
|
||||||
to [the main Terraform CLI documentation](https://www.terraform.io/docs/cli-index.html).
|
to [the main Terraform CLI documentation](https://www.terraform.io/docs/cli/index.html).
|
||||||
|
|
||||||
## Terraform Core Architecture Documents
|
## Terraform Core Architecture Documents
|
||||||
|
|
||||||
|
|
2
help.go
2
help.go
|
@ -41,7 +41,7 @@ func helpFunc(commands map[string]cli.CommandFactory) string {
|
||||||
sort.Strings(otherCommands)
|
sort.Strings(otherCommands)
|
||||||
|
|
||||||
// The output produced by this is included in the docs at
|
// The output produced by this is included in the docs at
|
||||||
// website/source/docs/commands/index.html.markdown; if you
|
// website/source/docs/cli/commands/index.html.markdown; if you
|
||||||
// change this then consider updating that to match.
|
// change this then consider updating that to match.
|
||||||
helpText := fmt.Sprintf(`
|
helpText := fmt.Sprintf(`
|
||||||
Usage: terraform [global options] <subcommand> [args]
|
Usage: terraform [global options] <subcommand> [args]
|
||||||
|
|
|
@ -92,7 +92,7 @@ func (r *ResourceAddress) String() string {
|
||||||
|
|
||||||
// HasResourceSpec returns true if the address has a resource spec, as
|
// HasResourceSpec returns true if the address has a resource spec, as
|
||||||
// defined in the documentation:
|
// defined in the documentation:
|
||||||
// https://www.terraform.io/docs/internals/resource-addressing.html
|
// https://www.terraform.io/docs/cli/state/resource-addressing.html
|
||||||
// In particular, this returns false if the address contains only
|
// In particular, this returns false if the address contains only
|
||||||
// a module path, thus addressing the entire module.
|
// a module path, thus addressing the entire module.
|
||||||
func (r *ResourceAddress) HasResourceSpec() bool {
|
func (r *ResourceAddress) HasResourceSpec() bool {
|
||||||
|
|
Loading…
Reference in New Issue