Skip to content

Update docs to new structure #13039

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

Merged
merged 24 commits into from
May 28, 2025
Merged

Update docs to new structure #13039

merged 24 commits into from
May 28, 2025

Conversation

koppor
Copy link
Member

@koppor koppor commented Apr 30, 2025

This updates the docs. Uses .sdkmanrc.

Follow-up to #12943


Before:

Extracts the mise things from #13036 - and updates the general documentation


Notes on NOT using mise

Mandatory checks

  • I own the copyright of the code submitted and I license it under the MIT license
  • [.] Change in CHANGELOG.md described in a way that is understandable for the average user (if change is visible to the user)
  • [.] Tests created for changes (if applicable)
  • [.] Manually tested changed features in running JabRef (always required)
  • [.] Screenshots added in PR description (if change is visible to the user)
  • [.] Checked developer's documentation: Is the information available and up to date? If not, I outlined it in this pull request.
  • [.] Checked documentation: Is the information available and up to date? If not, I created an issue at https://github.com/JabRef/user-documentation/issues or, even better, I submitted a pull request to the documentation repository.

@koppor koppor changed the title Use mise instead of GitHub actions [experiment] Use mise instead of GitHub actions May 1, 2025
@koppor
Copy link
Member Author

koppor commented May 4, 2025

The howto "feels" somewhat bloatet - however, reading IDEA 2025.1 doesn't understand that Gradle 8.14 works on Java 24? it might be necessary to describe how to run gradle on a different JDK than we use for compilation.

@koppor koppor changed the title [experiment] Use mise instead of GitHub actions [experiment] Use mise instead of IntelliJ JDK download May 13, 2025
@koppor koppor mentioned this pull request May 19, 2025
2 tasks
@Siedlerchr Siedlerchr closed this May 19, 2025
@koppor koppor mentioned this pull request May 19, 2025
2 tasks
@koppor koppor changed the title [experiment] Use mise instead of IntelliJ JDK download Update docs to new structure May 20, 2025
@koppor koppor reopened this May 20, 2025
@koppor koppor requested a review from subhramit May 28, 2025 18:25
@koppor koppor marked this pull request as ready for review May 28, 2025 18:25
@koppor koppor added the status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers label May 28, 2025
Copy link
Member

@subhramit subhramit May 28, 2025

Choose a reason for hiding this comment

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

See if this screenshot could be cropped a bit more from the left

Copy link
Member Author

Choose a reason for hiding this comment

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

Better than nothing 🙈

Press <kbd>Alt</kbd>+<kbd>0</kbd> to open the commit dialog.
## Allow JDK to access the internet

Allow also access in private networks and click "Allow access".
Copy link
Member

Choose a reason for hiding this comment

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

also?
Or maybe "allow access for both cases"?

@subhramit
Copy link
Member

subhramit commented May 28, 2025

@Yubo-Cao let us know if you have any comments as well, Yubo.
(In retrospect - for now we are merging at the current state)

koppor and others added 2 commits May 29, 2025 00:38
Co-authored-by: Subhramit Basu <subhramit.bb@live.in>
Copy link

trag-bot bot commented May 28, 2025

@trag-bot didn't find any issues in the code! ✅✨

@koppor koppor added this pull request to the merge queue May 28, 2025
@koppor
Copy link
Member Author

koppor commented May 28, 2025

@Yubo-Cao let us know if you have any comments as well, Yubo.

Yeah, sure! -- I went ahead with merging as this improves the state.

BTW: I used a Windows Sandbox made by Custom Sandbox, where I installed git with the following command

choco install git.install -y --params "/GitAndUnixToolsOnPath /WindowsTerminal /WindowsTerminalProfile

Merged via the queue into main with commit 3e1a4f4 May 28, 2025
4 checks passed
@koppor koppor deleted the switch-workflows-to-mise branch May 28, 2025 23:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants