-
-
Notifications
You must be signed in to change notification settings - Fork 4.1k
Fix URLs in generated readme.md #30710
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
base: main
Are you sure you want to change the base?
Conversation
de68b1f
to
c94443c
Compare
@SvMak suggestions? |
As far as I understand, the point of archive links is that the documentation changes, and they are used to maintain the connection between the documentation version and the generator. And this update will break this connection. The generator of any new version will link to the current version of the documentation even if something in it is out of date. P.S. I saw that the archive was broken, I'll look at it a little later. |
@qmonmert Seems that we can close it, right? |
@DanielFran not fixed I think @SvMak ? |
If I understand correctly, then: For example, if I'm using JHipster version 8.9.0 and creating a new project, my links point to the documentation, which corresponds to the generator version and is located in the archive. But if create links that point to the latest version of the documentation (for example, 8.11.0), then I potentially end up with out-of-date documentation if changes have been made. If this isn't critical, then this update is OK. |
@SvMak in the README of generated app with have some URLs like https://www.jhipster.tech/documentation-archive/v8.11.0 |
The release link is a good idea. As for the other links, it would be nice to clarify whether this would create the problem I described above. |
@SvMak I think the choice of the versions is not a big pb |
Alternatively, you could check: if using the latest version of the generator, then insert the links you suggest, otherwise, leave the current version with links to the archive. What do you think? |
For me, I think my proposition is simpler and clearer 😇 |
I like it! |
URLs in readme.md are KO
Examples:
URLs with releases have date now (ex: https://www.jhipster.tech/2025/05/06/jhipster-release-8.11.0.html)
My proposition is:
Before
After
Before
After
@DanielFran @mshima WDYT?