docs: consistent way of referencing API documentation #2928
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bene2k1
previously approved these changes
Feb 20, 2025
nerda-codes
previously approved these changes
Feb 20, 2025
nerda-codes
reviewed
Feb 20, 2025
docs/resources/mongodb_instance.md
Outdated
| @@ -6,7 +6,7 @@ page_title: "Scaleway: scaleway_mongodb_instance" | |||
| # Resource: scaleway_mongodb_instance | |||
|
|
|||
| Creates and manages Scaleway MongoDB® instance. | |||
| For more information refer to [the API documentation](https://www.scaleway.com/en/docs/managed-mongodb-databases/). | |||
| For more information refer to the [API documentation](https://www.scaleway.com/en/docs/managed-mongodb-databases/). | |||
There was a problem hiding this comment.
Suggested change
| For more information refer to the [API documentation](https://www.scaleway.com/en/docs/managed-mongodb-databases/). | |
| For more information refer to the [product documentation](https://www.scaleway.com/en/docs/managed-mongodb-databases/). |
ahamez
force-pushed
the
consistent_api_documentation_references
branch
from
c24adab to
0e84700
Compare
Sometimes it's referenced as 'API documentation', while other times it's referenced as 'documentation' only. - Some whitespaces were automatically stripped along the way - Fix one grammar issue
ahamez
force-pushed
the
consistent_api_documentation_references
branch
from
0e84700 to
67516db
Compare
remyleone
approved these changes
Feb 20, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Sometimes it's referenced as 'API documentation', while other times it's referenced as 'documentation' only.