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

change adds documentation for no-delete flag #5920

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

olamilekan000
Copy link
Contributor

@olamilekan000 olamilekan000 commented Jan 23, 2025

User description

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


https://tyktech.atlassian.net/browse/TT-13290
change adds documentation for no-delete flag for sync command.

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.
  • I labeled the PR

PR Type

Documentation


Description

  • Added documentation for the --no-delete flag in the tyk-sync sync command.

  • Clarified the purpose of the --no-delete flag to skip resource deletion.

  • Updated the flags section in the automations.md file.


Changes walkthrough 📝

Relevant files
Documentation
automations.md
Document `--no-delete` flag for `tyk-sync sync`                   

tyk-docs/content/api-management/automations.md

  • Added --no-delete flag to the list of tyk-sync sync command flags.
  • Explained the functionality of the --no-delete flag to skip resource
    deletion during synchronization.
  • +1/-1     

    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

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

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

    Documentation Clarity

    Ensure that the description for the --no-delete flag is clear and provides sufficient context for users to understand its purpose and implications during synchronization.

    | **Flags**     | `-b, --branch BRANCH`: Git branch (default "refs/heads/master")<br> `-d, --dashboard DASHBOARD_URL`: Dashboard URL<br> `-g, --gateway GATEWAY_URL`: Gateway URL<br> `-h, --help`: Help for sync command<br> `-k, --key SSHKEY`: SSH key file location<br> `-o, --org ORG_ID`: Override organization ID<br> `-p, --path PATH`: Source file directory<br> `-s, --secret SECRET`: API secret<br> `--no-delete`: Skip deletion of resources during synchronisation <br> `--test`: Use test publisher<br> `--apis IDS`: Specific API IDs to sync (to be deprecated)<br> `--policies IDS`: Specific policy IDs to sync (to be deprecated) |

    Copy link
    Contributor

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Score
    General
    Clarify the behavior of --no-delete flag

    Ensure that the description for the --no-delete flag explicitly clarifies its
    behavior, such as whether it skips deletion for all resources or specific ones, to
    avoid ambiguity for users.

    tyk-docs/content/api-management/automations.md [4414]

    -`--no-delete`: Skip deletion of resources during synchronisation <br>
    +`--no-delete`: Skip deletion of all resources during synchronisation to prevent accidental data loss <br>
    Suggestion importance[1-10]: 7

    Why: The suggestion improves the clarity of the --no-delete flag's description, which is important for users to understand its exact behavior and avoid potential misuse. However, the improvement is relatively minor and does not address a critical issue.

    7

    Copy link

    netlify bot commented Jan 23, 2025

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

    Name Link
    🔨 Latest commit cefdb64
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/67926aa84f1117000836bb3e
    😎 Deploy Preview https://deploy-preview-5920--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.

    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.

    1 participant