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-1854] Improve title for dashboard-configuration.md #6063

Merged
merged 4 commits into from
Mar 5, 2025

Conversation

letzya
Copy link
Collaborator

@letzya letzya commented Mar 4, 2025

User description

For internal users - Please add a Jira DX PR ticket to the subject!

And also get rid of the old usage of codeWrapper that we don't use


Preview Link


Description


Screenshots (if appropriate)


Checklist

  • I have added a preview link to the PR description.
  • I have reviewed the suggestions made by our AI (PR Agent) and updated them accordingly (spelling errors, rephrasing, etc.)
  • I have reviewed the guidelines for contributing to this repository.
  • I have read the technical guidelines for contributing to this repository.
  • Make sure you have started your change off our latest master.
  • For Tyk Members - Please add a Jira DX PR ticket to the subject!
  • For Tyk Members - I have added the appropriate release label to this PR:
    • If it is for a future release, label it as future-release and specify the version (e.g., future-release, 6.0).
    • If it should be merged into an older version, use the specific version label (e.g., 4.1, 5.1).
    • If no label is added, it will be assumed that the PR should be merged into the latest current version (e.g., 5.5) and master.

PR Type

Documentation


Description

  • Updated front matter title to "Manage the Tyk Dashboard".

  • Replaced deprecated code snippet wrappers with explicit language tags.

  • Standardized HTTP, curl, YAML, and JSON code sample formatting.

  • Improved overall documentation readability and consistency.


Changes walkthrough 📝

Relevant files
Documentation
dashboard-configuration.md
Update metadata and reformat code sample blocks in dashboard
configuration.

tyk-docs/content/api-management/dashboard-configuration.md

  • Changed title from "Dashboard Configuration" to "Manage the Tyk
    Dashboard".
  • Updated tags, description, and keywords for clarity.
  • Replaced "{.copyWrapper}" with specific language tags (http, curl,
    json, yaml).
  • Fixed minor formatting and whitespace inconsistencies in code blocks.
  • +101/-89

    Need help?
  • Type /help how to ... in the comments thread for any questions about PR-Agent usage.
  • Check out the documentation for more information.
  • Copy link
    Contributor

    github-actions bot commented Mar 4, 2025

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 3 🔵🔵🔵⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Code Block Typo

    The new sample response block starting around the "yalm" marker appears to include a typo. It should likely be "yaml" to ensure proper syntax highlighting.

    ```yalm

    @letzya letzya changed the title Improve title for dashboard-configuration.md [DX-1854] Improve title for dashboard-configuration.md Mar 4, 2025
    Copy link

    netlify bot commented Mar 4, 2025

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

    Name Link
    🔨 Latest commit 20c2720
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/67c7dffa8303d60008efab7e
    😎 Deploy Preview https://deploy-preview-6063--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.

    Copy link
    Contributor

    github-actions bot commented Mar 4, 2025

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Impact
    Possible issue
    Fix YAML language tag

    Correct the code block language tag from yalm to yaml for proper syntax
    highlighting.

    tyk-docs/content/api-management/dashboard-configuration.md [1685]

    -```yalm
    +```yaml
     {
       "data": [
     ...
    Suggestion importance[1-10]: 5

    __

    Why: The suggestion correctly identifies and fixes a typo in the code block language tag from "yalm" to "yaml", which improves syntax highlighting. However, it addresses only a minor formatting issue.

    Low
    Fix header formatting

    Insert the missing colon in the Authorization header for consistent HTTP header
    formatting.

    tyk-docs/content/api-management/dashboard-configuration.md [2270]

    -Authorization 64c8e662f6924c4f55e94a873d75e44d
    +Authorization: 64c8e662f6924c4f55e94a873d75e44d
    Suggestion importance[1-10]: 5

    __

    Why: The suggestion points out a missing colon in the Authorization header, ensuring consistent HTTP header formatting. It is a valid and actionable change but only impacts a minor formatting detail.

    Low

    @sharadregoti sharadregoti enabled auto-merge (squash) March 5, 2025 05:24
    @sharadregoti sharadregoti merged commit d2455d1 into master Mar 5, 2025
    11 checks passed
    @sharadregoti sharadregoti deleted the letzya-improve-title branch March 5, 2025 05:25
    @sharadregoti
    Copy link
    Contributor

    /release to release-5.7

    Copy link

    tykbot bot commented Mar 5, 2025

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

    Copy link

    tykbot bot commented Mar 5, 2025

    Still working...

    Copy link

    tykbot bot commented Mar 5, 2025

    @sharadregoti Succesfully merged PR

    buger added a commit that referenced this pull request Mar 5, 2025
    …ration.md (#6063)
    
    [DX-1854] Improve title for dashboard-configuration.md (#6063)
    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