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-1376] Create Alias For Troubleshooting Page #4682

Merged
merged 2 commits into from
Jun 3, 2024
Merged

[DX-1376] Create Alias For Troubleshooting Page #4682

merged 2 commits into from
Jun 3, 2024

Conversation

dcs3spp
Copy link
Contributor

@dcs3spp dcs3spp commented May 24, 2024

User description

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

DX-1376


Preview Link

troubleshooting redirects to developer support

Description

Remove empty troubleshooting page and set up and alias

Screenshots (if appropriate)


Checklist

  • I have added a preview link to the PR description.
  • 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 labelled the PR

PR Type

documentation


Description

  • Added an alias for the /troubleshooting/ URL to redirect to the FAQ page.
  • Removed the empty troubleshooting page.

Changes walkthrough 📝

Relevant files
Documentation
faq.md
Added alias for troubleshooting page in FAQ                           

tyk-docs/content/frequently-asked-questions/faq.md

  • Added alias for /troubleshooting/ to redirect to the FAQ page.
+1/-0     
troubleshooting.md
Removed empty troubleshooting page                                             

tyk-docs/content/troubleshooting.md

  • Removed the empty troubleshooting page.
+0/-9     

💡 PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

@dcs3spp dcs3spp added the all label May 24, 2024
Copy link

netlify bot commented May 24, 2024

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

Name Link
🔨 Latest commit d4e22fd
🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/6650b77d3a9f2c0008c1b504
😎 Deploy Preview https://deploy-preview-4682--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

netlify bot commented May 24, 2024

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

Name Link
🔨 Latest commit ac41d2f
🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/665d7b06057c3e000885446c
😎 Deploy Preview https://deploy-preview-4682--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.

@dcs3spp dcs3spp marked this pull request as ready for review May 24, 2024 16:44
Copy link
Contributor

PR Description updated to latest commit (dc8fb36)

Copy link
Contributor

PR Review 🔍

⏱️ Estimated effort to review [1-5]

2, because the changes are straightforward involving the removal of a redundant page and updating an alias in another page. The context and impact of these changes are clear, making the review process relatively simple.

🧪 Relevant tests

No

⚡ Possible issues

No

🔒 Security concerns

No

Code feedback:
relevant filetyk-docs/content/frequently-asked-questions/faq.md
suggestion      

Ensure that the alias addition does not conflict with existing pages or future planned content. Adding an alias should be carefully managed to avoid URL conflicts and ensure that users are redirected appropriately. [important]

relevant line- /troubleshooting/

Copy link
Contributor

PR Code Suggestions ✨

CategorySuggestion                                                                                                                                    Score
Possible issue
Verify and correct the target of the new alias to ensure it points to an existing and relevant page

Ensure that the alias '/troubleshooting/' does not redirect to a non-existent or
irrelevant page. Verify the target page exists and is correctly linked to this alias to
avoid broken links and improve user navigation.

tyk-docs/content/frequently-asked-questions/faq.md [16]

 aliases:
   - /developer-support/
-  - /troubleshooting/
+  - /correct-troubleshooting-link/
 
Suggestion importance[1-10]: 7

Why: The suggestion is valid as it highlights the importance of verifying that the new alias points to an existing and relevant page, which is crucial for maintaining proper navigation and avoiding broken links. However, the improved code provided is hypothetical and assumes the correct link without verification.

7

@dcs3spp dcs3spp requested a review from letzya May 30, 2024 15:11
Copy link
Collaborator

@letzya letzya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

preview link is wrong but the pr is good

@dcs3spp dcs3spp merged commit ec46fd8 into master Jun 3, 2024
10 checks passed
@dcs3spp dcs3spp deleted the dx-1376 branch June 3, 2024 11:44
@dcs3spp
Copy link
Contributor Author

dcs3spp commented Jun 3, 2024

/release to release-5.3

Copy link

tykbot bot commented Jun 3, 2024

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

tykbot bot pushed a commit that referenced this pull request Jun 3, 2024
create alias for troubleshooting page

Co-authored-by: Simon Pears <simon@tyk.io>
(cherry picked from commit ec46fd8)
Copy link

tykbot bot commented Jun 3, 2024

@dcs3spp Succesfully merged PR

@dcs3spp
Copy link
Contributor Author

dcs3spp commented Jun 3, 2024

/release to release-5.2

Copy link

tykbot bot commented Jun 3, 2024

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

tykbot bot pushed a commit that referenced this pull request Jun 3, 2024
create alias for troubleshooting page

Co-authored-by: Simon Pears <simon@tyk.io>
(cherry picked from commit ec46fd8)
Copy link

tykbot bot commented Jun 3, 2024

@dcs3spp Succesfully merged PR

@dcs3spp
Copy link
Contributor Author

dcs3spp commented Jun 3, 2024

/release to release-5.1

Copy link

tykbot bot commented Jun 3, 2024

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

tykbot bot pushed a commit that referenced this pull request Jun 3, 2024
create alias for troubleshooting page

Co-authored-by: Simon Pears <simon@tyk.io>
(cherry picked from commit ec46fd8)
Copy link

tykbot bot commented Jun 3, 2024

@dcs3spp Succesfully merged PR

buger added a commit that referenced this pull request Jun 3, 2024
…ge (#4682)

[DX-1376] Create Alias For Troubleshooting Page (#4682)

create alias for troubleshooting page

Co-authored-by: Simon Pears <simon@tyk.io>
@dcs3spp
Copy link
Contributor Author

dcs3spp commented Jun 3, 2024

/release to release-5

Copy link

tykbot bot commented Jun 3, 2024

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

tykbot bot pushed a commit that referenced this pull request Jun 3, 2024
create alias for troubleshooting page

Co-authored-by: Simon Pears <simon@tyk.io>
(cherry picked from commit ec46fd8)
Copy link

tykbot bot commented Jun 3, 2024

@dcs3spp Succesfully merged PR

buger added a commit that referenced this pull request Jun 3, 2024
…ge (#4682)

[DX-1376] Create Alias For Troubleshooting Page (#4682)

create alias for troubleshooting page

Co-authored-by: Simon Pears <simon@tyk.io>
buger added a commit that referenced this pull request Jun 3, 2024
…ge (#4682)

[DX-1376] Create Alias For Troubleshooting Page (#4682)

create alias for troubleshooting page

Co-authored-by: Simon Pears <simon@tyk.io>
buger added a commit that referenced this pull request Jun 3, 2024
…#4682)

[DX-1376] Create Alias For Troubleshooting Page (#4682)

create alias for troubleshooting page

Co-authored-by: Simon Pears <simon@tyk.io>
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