intuit / Trapheus

This tool automates restoration of RDS database instances from snapshots into any dev, staging or production environments. It supports individual RDS Snapshot as well as cluster snapshot restore operations.
https://intuit.github.io/Trapheus/
MIT License
101 stars 52 forks source link

Fix broken readme links to be compatible with the AWS blog #124

Closed namitad closed 9 months ago

namitad commented 9 months ago

Please ensure your issue adheres to the following guidelines:

Thanks for contributing!

As part of the "Getting started with Trapheus" section in AWS blog published on trapheus: https://aws.amazon.com/blogs/opensource/what-is-trapheus/ , there are some links to specific sections of the readme. these links are currently broken in our github repo.

Example:

Screenshot 2023-09-26 at 4 09 48 PM

Currently, the link in the screenshot above is https://github.com/intuit/Trapheus#pre-requisites and should redirect to the prerequisites section of our readme but the link in github is https://github.com/intuit/Trapheus#-pre-requisites.

the request is to fix all the github links to ensure the ones mentioned in the blog work as expected.

Agnik7 commented 9 months ago

Hi! I would like to work on this issue. Requesting the maintainer(s) to assign this issue to me.

namitad commented 9 months ago

@Agnik7 have assigned this issue to you.

Agnik7 commented 9 months ago

Hi @namitad I am a beginner to open source. Could you kindly guide me as to which files need to be changed?

namitad commented 9 months ago

@Agnik7 the changes you need to make in the README.md file. the links to different sections of the readme as provided in the above blog are broken. you need to make changes such that links in the readme match the links provided in the blog. so you can start with checking what are the links used in the blog (i have provided a sample above) and the cross check in the README.md file to see what changes would be needed in each header for links to match.

Agnik7 commented 9 months ago

@namitad I have a query. I just checked it, the links in the README.md file are working in the README, but are broken in the aws blog. I don't have an aws account, so I can't edit the blog directly. Is there a way to work around that? I am asking this since the links provided in the README are perfectly valid ones.

namitad commented 9 months ago

@Agnik7 The blog cannot be edited. You need to change the links in the github repo so that they match the ones that are in the blog.

namitad commented 9 months ago

Basically there were some changes made in the readme post the blog was published which changed the link structure. This resulted in broken links in the blog.

Agnik7 commented 9 months ago

Ok got it👍

Agnik7 commented 9 months ago

@namitad I have created a PR #145 to address this issue. Requesting you to kindly review it.