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

Update (now dead) jet-start.sh links [OLDDOCS-708] #34

Merged
merged 5 commits into from
Dec 19, 2024

Conversation

JackPGreen
Copy link
Contributor

@JackPGreen JackPGreen commented Dec 19, 2024

The jet-start.sh links no longer work.

Although Jet is deprecated, the links should still point to relevant content under our control - updated to use either:

  • the backing sources in GitHub
  • Javadoc produced from the public Maven artefacts

Slack discussion.

Partially addresses OLDDOCS-708

@JackPGreen JackPGreen self-assigned this Dec 19, 2024
@JackPGreen JackPGreen marked this pull request as ready for review December 19, 2024 12:09
@JackPGreen JackPGreen changed the title Update (now dead) jet-start.sh links Update (now dead) jet-start.sh links [OLDDOCS-708] Dec 19, 2024
@JackPGreen JackPGreen requested a review from k-jamroz December 19, 2024 12:13
@@ -6,9 +6,9 @@ Download_ZIP_URL: https://repository.hazelcast.com/download/jet-enterprise/hazel
Download_ZIP_Size: 669 MB
Download_TAR_URL: https://repository.hazelcast.com/download/jet-enterprise/hazelcast-jet-enterprise-4.5.4.tar.gz
Download_TAR_Size: 669 MB
Docs_HTML: https://jet-start.sh/docs
Docs_HTML: https://github.com/hazelcast/hazelcast-jet/tree/master/site/docs

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will that update links in https://hazelcast.com/community-edition-projects/downloads/archives?

Should do. master probably isn't right for every version but they were all the same before, so...

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@@ -64,10 +64,10 @@ Download_ZIP_URL: https://repository.hazelcast.com/download/jet-enterprise/hazel
Download_ZIP_Size: 573 MB
Download_TAR_URL: https://repository.hazelcast.com/download/jet-enterprise/hazelcast-jet-enterprise-4.5.tar.gz
Download_TAR_Size: 573 MB
Docs_HTML: https://jet-start.sh/docs
Docs_HTML: https://github.com/hazelcast/hazelcast-jet/tree/master/site/docs

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://docs.hazelcast.com/hazelcast/latest/pipelines/overview might be a better entry point to Jet docs

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's not Jet-centric though?

The documentation used to look like this, included installation instructions etc.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's not Jet-centric though?

why? https://docs.hazelcast.com/hazelcast/latest/pipelines/overview is all about Jet

The documentation used to look like this, included installation instructions etc.

the full link to old main page would be https://github.com/hazelcast/hazelcast-jet/blob/master/site/docs/get-started/intro.md. some topics like installation are very different in >=5.0 versions.

I guess that for the sake of historical accuracy we can link to the old docs for 4.x version

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's not Jet-centric though?

why? https://docs.hazelcast.com/hazelcast/latest/pipelines/overview is all about Jet

Sorry - I meant Jet, the standalone product - not Jet, the idea.

The documentation used to look like this, included installation instructions etc.

the full link to old main page would be https://github.com/hazelcast/hazelcast-jet/blob/master/site/docs/get-started/intro.md. some topics like installation are very different in >=5.0 versions.

I guess that for the sake of historical accuracy we can link to the old docs for 4.x version

I thought if I linked to the pages direct, you can't see easily see the navigation. But the GitHub UI has.... something?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't have any particular navigation for the docs in github in either case. intro.md at least shows some text instead of list of files

@JackPGreen JackPGreen merged commit f1f6448 into hazelcast:master Dec 19, 2024
2 checks passed
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

Successfully merging this pull request may close these issues.

4 participants