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

[DX-1520] Add explanation to the use of catalogue and catalog #5084

Merged
merged 4 commits into from
Jul 16, 2024

Conversation

Copy link
Contributor

PR Reviewer Guide 🔍

⏱️ Estimated effort to review: 3 🔵🔵🔵⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Key issues to review

Spelling Consistency
The document mentions the use of British English in the product but uses American English in the documentation. Ensure consistency in terminology, especially for key terms that might affect user searches and SEO.

Code Block Formatting
The change from {.copyWrapper} to triple backticks might affect how code is displayed or copied in the documentation. Verify that this change aligns with the documentation's styling guidelines and does not impact functionality.

Response Format Consistency
The response format for some API calls has been changed from JSON to YAML. Confirm that this change is intentional and consistent with other parts of the documentation.

Copy link
Contributor

PR Code Suggestions ✨

CategorySuggestion                                                                                                                                    Score
Enhancement
Improve grammar and clarity in the description text

The description text contains a typo and is not grammatically correct. Consider
revising it to enhance clarity and professionalism.

tyk-docs/content/tyk-apis/tyk-portal-api/portal-documentation.md [4]

-description: "Descript the endpoint API admin or owner can use to publishing their API in the developer portal"
+description: "Description of the endpoints that API admins or owners can use to publish their APIs on the developer portal."
 
Suggestion importance[1-10]: 9

Why: The suggestion corrects a grammatical error and improves the clarity of the description, which enhances the professionalism and readability of the documentation.

9
Best practice
Replace HTML break tags with markdown spacing techniques

The use of
tags for spacing in markdown is not recommended. Consider using markdown
spacing techniques such as multiple newlines or restructuring the content.

tyk-docs/content/tyk-apis/tyk-portal-api/portal-documentation.md [9-19]

-</br>
+<!-- Use a blank line for spacing -->
 
Suggestion importance[1-10]: 8

Why: Using markdown spacing techniques instead of HTML tags is a best practice that ensures better compatibility and readability in markdown files.

8
Maintainability
Streamline the content in the note section for clarity and brevity

The note section can be made more concise and clear by removing redundant
information and focusing on the key message.

tyk-docs/content/tyk-apis/tyk-portal-api/portal-documentation.md [13-18]

 **Important Note on Spelling:**
-While our documentation now uses American English, the product itself, including UI, configuration fields, environment
-variables, and APIs endpoints, retain British English spellings. When interacting with the product, please continue
-using the British English spellings as they appear in the interface and API. (This means that for existing users nothing
-has changed).
+Our documentation uses American English, but the product retains British English spellings in the UI, configuration fields, environment variables, and API endpoints. Please use British English when interacting with these elements.
 
Suggestion importance[1-10]: 7

Why: The suggestion makes the note more concise and easier to read, which improves maintainability and user comprehension.

7

Copy link

netlify bot commented Jul 15, 2024

PS. Pls add /docs/nightly to the end of url

Name Link
🔨 Latest commit f75f299
🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/669608a6e6acbc00088c8a72
😎 Deploy Preview https://deploy-preview-5084--tyk-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

tyk-docs/content/tyk-portal-api.md Outdated Show resolved Hide resolved
@yurisasuke yurisasuke merged commit cf48485 into master Jul 16, 2024
10 checks passed
@yurisasuke yurisasuke deleted the letz-gb-to-us-message branch July 16, 2024 05:53
@yurisasuke
Copy link
Member

/release to release-5.4

Copy link

tykbot bot commented Jul 16, 2024

Working on it! Note that it can take a few minutes.

tykbot bot pushed a commit that referenced this pull request Jul 16, 2024
* Add explanation to the use of catalogue and catalog

* Update tyk-docs/content/tyk-apis/tyk-portal-api/portal-documentation.md

* Update tyk-docs/content/tyk-portal-api.md

* Update portal-documentation.md

(cherry picked from commit cf48485)
Copy link

tykbot bot commented Jul 16, 2024

@Keithwachira Succesfully merged PR

@yurisasuke
Copy link
Member

/release to release-5.3

Copy link

tykbot bot commented Jul 16, 2024

Working on it! Note that it can take a few minutes.

tykbot bot pushed a commit that referenced this pull request Jul 16, 2024
* Add explanation to the use of catalogue and catalog

* Update tyk-docs/content/tyk-apis/tyk-portal-api/portal-documentation.md

* Update tyk-docs/content/tyk-portal-api.md

* Update portal-documentation.md

(cherry picked from commit cf48485)
Copy link

tykbot bot commented Jul 16, 2024

@Keithwachira Succesfully merged PR

buger added a commit that referenced this pull request Jul 16, 2024
…ogue and catalog (#5084)

[DX-1520] Add explanation to the use of catalogue and catalog (#5084)

* Add explanation to the use of catalogue and catalog

* Update tyk-docs/content/tyk-apis/tyk-portal-api/portal-documentation.md

* Update tyk-docs/content/tyk-portal-api.md

* Update portal-documentation.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants