-
Notifications
You must be signed in to change notification settings - Fork 88
CLOUDP-112245: [Milestone] Atlascli/Mongocli Doc changes #975
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
gen-docs: gen-docs-mongocli gen-docs-atlascli ## Generate docs for commands | ||
|
||
gen-docs-mongocli: ## Generate docs for mongocli commands | ||
@echo "==> Generating docs for mongocli" | ||
go run ./internal/docs/mongocli/main.go | ||
|
||
gen-docs-atlascli: ## Generate docs for atlascli commands | ||
@echo "==> Generating docs for atlascli" | ||
go run ./internal/docs/atlascli/main.go |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is one change
internal/docs/atlascli/main.go
Outdated
// Copyright 2022 MongoDB Inc | ||
// | ||
// Licensed under the Apache License, Version 2.0 (the "License"); | ||
// you may not use this file except in compliance with the License. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is the second change
internal/docs/mongocli/main.go
Outdated
@@ -31,13 +31,13 @@ func setDisableAutoGenTag(cmd *cobra.Command) { | |||
} | |||
|
|||
func main() { | |||
if err := os.RemoveAll("./docs/command"); err != nil { | |||
if err := os.RemoveAll("./docs/mongocli/command"); err != nil { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is the last change
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is docs prepare for this change? what happens if we need to release tomorrow?
they are a reviewer of this PR so we will merge this only when they are ready |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM if LGTDOCS
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM from docs side, thanks!
Proposed changes
Jira ticket: CLOUDP-112245
Checklist
make fmt
and formatted my codeFurther comments
Description:
Changes:
docs/commands
todocs/mongocli/commands
-> This is a breaking change for the doc tooldocs/atlascli/commands