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

Jhipster v7.x documentation #28407

Closed
zirconias opened this issue Jan 7, 2025 · 20 comments
Closed

Jhipster v7.x documentation #28407

zirconias opened this issue Jan 7, 2025 · 20 comments
Milestone

Comments

@zirconias
Copy link

zirconias commented Jan 7, 2025

Trying to find/access Jhipster v7.x documentation, but it's no more available on gh-pages.

Links to old documentation can be found at https://www.jhipster.tech/documentation-archive/. While many of these links work, if you click on v7.5.0, which points to https://www.jhipster.tech/documentation-archive-v6-to-v7/v7.5.0/, it doesn't work.

@DanielFran
Copy link
Member

@zirconias
Copy link
Author

Hi @DanielFran , if it's no more publically compiled/published (talking about docs for v6, v7 jhipster)
then it looks like what i'm looking for, just need to build it myself.
need to do an upgrade for a project in production to the la test, and should go through all documentations to find best way to upgrade.

@zirconias
Copy link
Author

i tried to build locally and on docker using provided dockerfiles. but in vain, couldn't build any of the legacy version.

Can someone help ? i do have an app in prodcution using v7.2, and need to upgrade it, gradually to the latest version.

@mraible
Copy link
Contributor

mraible commented Jan 21, 2025

What command are you using and what is the error?

@zirconias
Copy link
Author

zirconias commented Jan 21, 2025

@mraible Hi!,
i followed both approaches , take v7.5.0 as an example.
On windows, trying to install jekyll, npm instal.... didn't work, tried different ruby version.
but also compsoe which should be garanteed to work here are the logs building using docker-desktop v4.37.1
time="2025-01-21T20:34:54+01:00" level=warning msg="C:\\Users\\user\\Downloads\\documentation-archive-v6-to-v7-main\\v7.5.0\\docker-compose.yml: the attributeversionis obsolete, it will be ignored, please remove it to avoid potential confusion" [+] Running 7/7 ✔ site Pulled 19.1s ✔ df9b9388f04a Pull complete 0.9s ✔ 837e9cfc7e43 Pull complete 1.5s ✔ c7850f1a8c23 Pull complete 1.5s ✔ 6ca4c39baa3d Pull complete 3.5s ✔ daa3a8cb79d3 Pull complete 3.5s ✔ cf5821b9dd48 Pull complete 17.4s [+] Running 2/2 ✔ Network v750_default Created 0.1s ✔ Container jhipster.github.io Created 0.6s Attaching to jhipster.github.io jhipster.github.io | Bundler 2.3.25 is running, but your lockfile was generated with 2.2.2. Installing Bundler 2.2.2 and restarting using that version. jhipster.github.io | Fetching gem metadata from https://rubygems.org/. jhipster.github.io | Fetching bundler 2.2.2 jhipster.github.io | Installing bundler 2.2.2 jhipster.github.io | Fetching gem metadata from https://rubygems.org/......... jhipster.github.io | nokogiri-1.11.7-x86_64-linux requires ruby version < 3.1.dev, >= 2.5, which is jhipster.github.io | incompatible with the current version, ruby 3.1.1p18

@mraible
Copy link
Contributor

mraible commented Jan 21, 2025

Why do you need to generate a Docker container with the documentation? If it's available on the website, isn't that good enough?

Links to old documentation can be found at https://www.jhipster.tech/documentation-archive/. While many of these links work, I've found that if I click on v7.5.0, which points to https://www.jhipster.tech/documentation-archive-v6-to-v7/v7.5.0/, it doesn't work. Do you know why, @SvMak?

@zirconias
Copy link
Author

all versions v7.x.x are not found on the link you shared, that's why i had to build it locally.

also the referenced links in the menu are pointing to the latest version of jhipster. so you'll be redirected to current jhipster.

i need to go through the version to incrementally migrate v7.2 to latest. or is there any other way to proceed? we do have separate backend and frontend production app.

@SvMak
Copy link

SvMak commented Jan 21, 2025

@mraible

This part of the documentation is in a separate repository. Could you please clarify whether the routes were configured similarly to the documentation for versions 1-5?

@mraible
Copy link
Contributor

mraible commented Jan 21, 2025

@SvMak I didn't know anything was required to make things work. I'm guessing the routes might require a Cloudflare configuration change? @jdubois Do you know anything about this?

@mraible mraible added $100 https://www.jhipster.tech/bug-bounties/ $$ bug-bounty $$ https://www.jhipster.tech/bug-bounties/ and removed area: triage theme: undefined labels Jan 21, 2025
@SvMak
Copy link

SvMak commented Jan 21, 2025

I didn't know anything was required to make things work. I'm guessing the routes might require a Cloudflare configuration change?

I think so, because this part is hosted separately.

@jdubois
Copy link
Member

jdubois commented Jan 22, 2025

I don't think there's anything specific for Cloudflare here, all it does it transform https://jhipster.github.io/documentation-archive/ to https://www.jhipster.tech/documentation-archive/

The archive is coming from https://github.com/jhipster/documentation-archive but indeed I don't see the old documentation here, it must have been deleted!

@jdubois
Copy link
Member

jdubois commented Jan 22, 2025

As in https://github.com/jhipster/documentation-archive/graphs/contributors @SvMak you seem to have deleted 18 million of lines, I believe you did a mistake somewhere here. You can probably rollback?

@SvMak
Copy link

SvMak commented Jan 22, 2025

As in https://github.com/jhipster/documentation-archive/graphs/contributors @SvMak you seem to have deleted 18 million of lines, I believe you did a mistake somewhere here. You can probably rollback?

The documentation at this stage consists of 3 parts due to space limitations for GitHub Pages.

  1. jhipster.tech/documentation-archive-v1-to-v5/ (repo - https://github.com/jhipster/documentation-archive-v1-to-v5) - working
  2. jhipster.tech/documentation-archive-v6-to-v7/ (repo - https://github.com/jhipster/documentation-archive-v6-to-v7) - not working
  3. jhipster.tech/documentation-archive/ (repo - https://github.com/jhipster/documentation-archive) - working

Could you please check GitHub Pages setup for documentation-archive-v6-to-v7 repo and maybe CloudFlare setup(are there any specific settings for documentation-archive-v1-to-v5?).

@SvMak
Copy link

SvMak commented Jan 22, 2025

Image

Now the link is trying to be processed by Docusaurus (https://github.com/jhipster/jhipster.github.io), although it should lead to another repo (https://github.com/jhipster/documentation-archive-v6-to-v7).

@SvMak
Copy link

SvMak commented Jan 22, 2025

@jdubois
Copy link
Member

jdubois commented Jan 22, 2025

Oh I didn't know you split it in 3! I was expected this to happen at some point, as our repo was getting really big, then the 1Go limit on GitHub is a "soft limit" and I believe GitHub didn't care too much.

I don't see anything on CloudFlare, so I must be missing something....

Then @mraible I do see on https://github.com/jhipster/documentation-archive-v1-to-v5/settings/pages that you deployed this to GitHub Pages, but not on https://github.com/jhipster/documentation-archive-v6-to-v7/settings/pages -> I'm guessing this needs to be done anyway.

As you're the one who configured it initially, can you confirm @mraible ?

@mraible
Copy link
Contributor

mraible commented Jan 22, 2025

I don't remember configuring the first repository as GitHub pages, but it does show my name there. I just tried enabling the same settings for the 2nd archive. We'll see if that works.

@mraible
Copy link
Contributor

mraible commented Jan 22, 2025

Enabling GitHub pages did not work on its own. I had to make a small change and push it to main for the site to be published. You can now see the docs for v7.5.0 at https://www.jhipster.tech/documentation-archive-v6-to-v7/v7.5.0/.

@zirconias Does this solve your issue?

@zirconias
Copy link
Author

i confirm, thanks guys for helping us.

@mraible mraible removed $100 https://www.jhipster.tech/bug-bounties/ $$ bug-bounty $$ https://www.jhipster.tech/bug-bounties/ labels Jan 23, 2025
@mraible mraible closed this as completed Jan 23, 2025
@jdubois
Copy link
Member

jdubois commented Jan 23, 2025

Thanks @zirconias for telling us about the issue!!!

@mraible mraible added this to the 8.9.0 milestone Feb 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants