airshipctl/cmd/document/document.go
Sirisha Gopigiri 21f015b502 Updating cmd files for documentation
This PS updates cmd related to root, completion, document and
version subcommands. It also updates minor details in other
subcommands.

The description and examples are updated for the airshipctl
commands, which will be inturn used for generating documentation.
Please ignore the .md file changes in this PS. They are added for zuul
gates to pass. Here is the PS with generated documention
files https://review.opendev.org/c/airship/airshipctl/+/789250

Relates-To: #280
Change-Id: I562c15c0d25b2e9731c0eb03854d1d348eb435f2
2021-06-09 09:56:21 +00:00

39 lines
1.1 KiB
Go

/*
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
https://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.
*/
package document
import (
"github.com/spf13/cobra"
"opendev.org/airship/airshipctl/pkg/config"
)
const documentLong = `
Provides commands which help in management of site manifest documents.
`
// NewDocumentCommand creates a new command for managing airshipctl documents
func NewDocumentCommand(cfgFactory config.Factory) *cobra.Command {
documentRootCmd := &cobra.Command{
Use: "document",
Short: "Airshipctl command to manage site manifest documents",
Long: documentLong,
}
documentRootCmd.AddCommand(NewPullCommand(cfgFactory))
return documentRootCmd
}