Skip to content

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

Merged
merged 1 commit into from
Mar 2, 2022

Conversation

andreaangiolillo
Copy link
Collaborator

@andreaangiolillo andreaangiolillo commented Feb 10, 2022

Proposed changes

Jira ticket: CLOUDP-112245

Checklist

  • I have signed the MongoDB CLA
  • I have added tests that prove my fix is effective or that my feature works
  • I have added any necessary documentation in document requirements section listed in CONTRIBUTING.md (if appropriate)
  • I have addressed the @mongodb/docs-cloud-team comments (if appropriate)
  • I have updated e2e/E2E-TESTS.md (if an e2e test has been added)
  • I have run make fmt and formatted my code

Further comments

Description:
Changes:

  • This PR moves the docs file from docs/commands to docs/mongocli/commands -> This is a breaking change for the doc tool
  • We generated the atlascli doc in docs/atlascli/commands

@andreaangiolillo andreaangiolillo requested a review from a team as a code owner February 10, 2022 10:45
@andreaangiolillo andreaangiolillo requested review from a team and fmenezes and removed request for a team February 10, 2022 10:45
Comment on lines +92 to +100
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
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This is one change

// 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.
Copy link
Collaborator Author

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

@@ -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 {
Copy link
Collaborator Author

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

Copy link
Collaborator

@gssbzn gssbzn left a 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?

@andreaangiolillo
Copy link
Collaborator Author

they are a reviewer of this PR so we will merge this only when they are ready

Copy link
Collaborator

@gssbzn gssbzn left a comment

Choose a reason for hiding this comment

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

LGTM if LGTDOCS

Copy link
Contributor

@sarahsimpers sarahsimpers left a 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!

@andreaangiolillo andreaangiolillo merged commit 405a4db into master Mar 2, 2022
@andreaangiolillo andreaangiolillo deleted the CLOUDP-112245 branch March 2, 2022 12:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants