schemacrawler / SchemaCrawler

Free database schema discovery and comprehension tool
http://www.schemacrawler.com/
Other
1.58k stars 200 forks source link

Link to examples is hard to follow #1524

Closed ArtskydJ closed 1 month ago

ArtskydJ commented 2 months ago

Description

In https://www.schemacrawler.com/schemacrawler-grep.html I clicked the "SchemaCrawler examples" link which brought me to github.com/schemacrawler/SchemaCrawler/releases/. I assumed it was an incorrect link as I didn't see any links for downloading examples. I downloaded the Source Code zip, and didn't see an "examples" folder. After a while, I did find it in the distribution file.

Maybe there's a way to make it more obvious?

A second issue is to get the <1 MB of examples, I had to download >380 MB zip file.


Anyway, I wanted to bring to your attention that the messaging could be clearer. Feel free to close this issue.

ArtskydJ commented 2 months ago

A second disappointment is that the grep example in the zip file is not that different from what's in https://www.schemacrawler.com/schemacrawler-grep.html and is actually less advanced.

screenshots ## website: ![image](https://github.com/schemacrawler/SchemaCrawler/assets/1833684/f6eb1d4f-7148-4e04-a0f8-bf11992e425a) ## from distribution.zip examples/grep/grep-readme.html ![image](https://github.com/schemacrawler/SchemaCrawler/assets/1833684/cf75d776-3f83-48dd-9cdd-bfb2e700924e)
ArtskydJ commented 2 months ago

Anyway, sorry, I don't mean to be complainy! Thanks for making this tool. I'm just gonna experiment a bit to try to get grep working the way I want it to. 🙂

sualeh commented 2 months ago

@ArtskydJ Thanks for reporting this. I will fix the documentation.

sualeh commented 1 month ago

@ArtskydJ I have addressed this.