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
106 stars 53 forks source link

Modify Trapheus readme to include TrapheusAI as well #170

Closed stationeros closed 10 months ago

stationeros commented 11 months ago

Trapheus now includes another subproject TrapheusAI . Can we modify the parent readme to include both and clicking of any of them opens up the detailed readme of the required one.

patHyatt commented 11 months ago

Where should this be grouped under? image

stationeros commented 11 months ago

@patHyatt The above is the documentation for Trapheus. There is one for TrapheusAI as well, which is its labs experimental counterpart for now. We need to create a new readme.md files with hyperlinks so that the user can browse which the one they want

yash-1o1 commented 11 months ago

Can you please assign this to me.

Thank you!

yash-1o1 commented 11 months ago

What approach seems to be more suitable?

Option One: Consolidate into a comprehensive readme document structured as follows:

-> Introduction -> Link to Trapheus section -> Link to TrapheusAI section -> Copy complete content from Trapheus's readme.md -> Copy complete content from TrapheusAI's readme.md

(Note: The links will direct readers to specific sections within this unified document, as it integrates all content from both individual readme files.)

Alternatively,

Option Two: Create a master readme file that orchestrates the structure as follows:

-> Introduction -> Link directing to the Trapheus readme file -> Link directing to the TrapheusAI readme file

(Note: These links will lead to separate directories dedicated to Trapheus and TrapheusAI, each maintaining its distinct readme file.)

stationeros commented 11 months ago

Option two seems fine

github-actions[bot] commented 10 months ago

This pull request has been automatically closed because it has been inactive for more than 14 days. Please reopen if you still intend to submit this pull request.