Skip to content
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

CLOUDP-303335: Remove AtlasCLI docs link from docs for auto-generated commands #3707

Merged
merged 4 commits into from
Mar 4, 2025

Conversation

cveticm
Copy link
Collaborator

@cveticm cveticm commented Mar 4, 2025

Proposed changes

This work removes URL pointing to AtlasCLI docs in docs. Instead, they will refer users to API documentation linked earlier in the description.

- For more information and examples, see: <url to docs of AtlasCLI command >
+ For more information and examples, see the referenced API documentation linked above.

This work does not include changes to proposed description messaging and I suggest leaving it as a separate work to allow time for more reviewers to LGTM the proposed message.

Jira ticket: CLOUDP-303335

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 test/README.md (if an e2e test has been added)
  • I have run make fmt and formatted my code

@cveticm cveticm force-pushed the CLOUDP-303335_update_help_and_docs_urls branch from 7c2bc02 to 53c31cb Compare March 4, 2025 14:36
@cveticm cveticm marked this pull request as ready for review March 4, 2025 15:42
@cveticm cveticm requested review from a team as code owners March 4, 2025 15:42
@cveticm cveticm force-pushed the CLOUDP-303335_update_help_and_docs_urls branch from ba85b31 to 5f7b7b2 Compare March 4, 2025 16:02
@cveticm cveticm force-pushed the CLOUDP-303335_update_help_and_docs_urls branch from 5f7b7b2 to 3af5890 Compare March 4, 2025 16:10
Copy link
Contributor

github-actions bot commented Mar 4, 2025

Coverage Report 📈

Branch Commit Coverage
master 1267c75 37.9%
CLOUDP-303335_update_help_and_docs_urls 3af5890 37.9%
Difference 0%

jeroenvervaeke
jeroenvervaeke previously approved these changes Mar 4, 2025
Copy link
Contributor

github-actions bot commented Mar 4, 2025

Coverage Report 📈

Branch Commit Coverage
master 1267c75 37.9%
CLOUDP-303335_update_help_and_docs_urls 8ab4961 37.9%
Difference 0%

@cveticm cveticm merged commit ae4fd9a into master Mar 4, 2025
22 checks passed
@cveticm cveticm deleted the CLOUDP-303335_update_help_and_docs_urls branch March 4, 2025 17:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants