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.

Sign up for GitHub

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

Jump to bottom

List of available javadocs #1904

Open
kazuryyx opened this issue Aug 11, 2023 · 3 comments
Open

List of available javadocs #1904

kazuryyx opened this issue Aug 11, 2023 · 3 comments
Labels
feature New feature request good first issue It would be great, if this issue could be solved by community

Comments

@kazuryyx
Copy link

kazuryyx commented Aug 11, 2023 •
edited
Loading

Request details

So, what if it was possible to add a javadocs viewer for example:

Lets say, having a repo up named like "SomeAPI" and you go to the page: "domain/javadoc/snapshots/me/somename/SomeAPI" It would give you a link that always points to the latest javadoc view where you can select all of the versions that are currently in "SomeAPI" and make you select one of the snapshot versions -> it opens the page on "domain/javadoc/snapshots/me/somename/SomeAPI/selectedVersion-SNAPSHOT" where people can then see the docs for this specific version, and not having to specify the version in a link.
@dzikoysk dzikoysk added feature New feature request and removed triage labels Aug 11, 2023
@dzikoysk dzikoysk changed the title Add javadocs viewer List of available javadocs Aug 11, 2023
@dzikoysk dzikoysk added the good first issue It would be great, if this issue could be solved by community label Aug 11, 2023
@mfnalex
Copy link

mfnalex commented Aug 11, 2023

I'd also like to see a "permanent" link that always shows the latest available javadocs - e.g. urltorepo/groupid/artifactid/javadoc-latest

@dzikoysk
Copy link
Owner

I think it was already request on our Discord server a while ago, so it's good to have an issue for that. Unfortunately, I'm slightly busy right now.

Because javadocs viewer is a part of backend, not frontend, we'd need to generate such list server side with raw html, just like this one:

reposilite/reposilite-backend/src/main/kotlin/com/reposilite/javadocs/JavadocView.kt

Lines 31 to 37 in 62deca6

val source = """
<html lang="en">
<head>
<meta charset="UTF-8" />
<title>Reposilite - JavaDoc</title>
</head>
<style>

@TechnicJelle
Copy link

I was just looking for something like this, too.
And while I haven't found a way to see all the available javadocs in a nice list or dropdown, I did find out that there is a permanent link to the latest javadoc version, by putting "latest" instead of the version number in the URL.
Example:
https://maven.reposilite.com/javadoc/releases/com/reposilite/reposilite/3.2.0
↓
https://maven.reposilite.com/javadoc/releases/com/reposilite/reposilite/latest

Though, it might be nice if this was an actual redirect, instead of a different URL that has the same content on it.
Like how GitHub Releases does it: if click on this URL:
https://github.com/dzikoysk/reposilite/releases/latest
it redirects to
https://github.com/dzikoysk/reposilite/releases/tag/3.5.14

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
feature New feature request good first issue It would be great, if this issue could be solved by community
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@mfnalex @dzikoysk @TechnicJelle @kazuryyx