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

Site: display download options for each artifact in tabs #8946

Merged
merged 9 commits into from
Jun 28, 2024

Conversation

adutra
Copy link
Contributor

@adutra adutra commented Jun 26, 2024

... also include more download options from Maven Central.

Copy link
Member

@snazy snazy left a comment

Choose a reason for hiding this comment

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

Funny, I tried this change initially, but wasn't happy with my own result. TL;DR the visual experience of the "tabs" was a bit annoying, because it's not immediately clear "that the tabs are actually tabs". Mind playing with the CSS for these and maybe make the inactive tabs appear with a light gray and the active tab with a bit darker gray?

java -jar nessie-quarkus-{{ versions.nessie }}-runner.jar
```

=== "Maven Central"
Copy link
Member

Choose a reason for hiding this comment

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

Not sure whether Maven coordinates for a distributable are helpful. I suspect it would rather confuse people. Better remove those from here and elsewhere.

The Snapshot-Repo information on the in-dev/index.md is fine. Should be made clearer though that this is meant for developing against Nessie - but maybe also include the nessie-bom as an enforcedPlatform() for Gradle and <dependencyManagement> for Maven poms. Might also be helpful to add a similar section to the release downloads.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Not sure whether Maven coordinates for a distributable are helpful. I suspect it would rather confuse people.

If someone needs to build a custom Nessie server, e.g. to add more extensions, that's exactly the snippet they would need to include, no?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Anyways I removed the Maven Central tabs.

I also tried to implement all your suggestions (not sure I got all of them right.)

@adutra
Copy link
Contributor Author

adutra commented Jun 27, 2024

Funny, I tried this change initially, but wasn't happy with my own result. TL;DR the visual experience of the "tabs" was a bit annoying, because it's not immediately clear "that the tabs are actually tabs". Mind playing with the CSS for these and maybe make the inactive tabs appear with a light gray and the active tab with a bit darker gray?

Here is how it looks on my end right now. I find it nice in fact.

image

Here is what I could get:

image

Is that OK? Tested on Chrome for Mac and Safari for Mac.

@snazy
Copy link
Member

snazy commented Jun 27, 2024

Is that OK? Tested on Chrome for Mac and Safari for Mac.

Yea! That looks much better! You can now see that these are tabs and not just text or heading.

margin-right: 2px;
}

.md-typeset .tabbed-set>input:first-child:checked~.tabbed-labels>:first-child,
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is a bit disappointing, but there is no CSS class specific to selected tabs, so basically the stylesheet attempts to apply the style to the first 20 tabs of a tabset, but only if they are selected.

Copy link
Member

Choose a reason for hiding this comment

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

Oh - I see, it's because of the two distinct sets of elements.

Mind adding a comment that there are two sets of elements? It took me a while to realize that.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

What do you mean by two sets? I count 20 rules. Are you referring to the next-sibling combinator ~?

Copy link
Member

Choose a reason for hiding this comment

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

The sets of input and label elements

Copy link
Member

@snazy snazy left a comment

Choose a reason for hiding this comment

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

Basically just one style suggestions, corrections to the group-ID and some enhancement proposals.

</dependency>
</dependencies>
</dependencyManagement>
```
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
```
```
Then you can use all Nessie artifacts like this:
```xml
<dependencies>
<dependency>
<groupId>org.projectnessie.nessie</groupId>
<artifactId>nessie-client</artifactId>
</dependency>
</dependencies>
```

<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.projectnessie</groupId>
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
<groupId>org.projectnessie</groupId>
<groupId>org.projectnessie.nessie</groupId>

In your Gradle project's `build.gradle.kts` add the Nessie BOM as an enforced platform:
```kotlin
dependencies {
enforcedPlatform("org.projectnessie:nessie-bom:{{ versions.nessie }}")
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
enforcedPlatform("org.projectnessie:nessie-bom:{{ versions.nessie }}")
enforcedPlatform("org.projectnessie.nessie:nessie-bom:{{ versions.nessie }}")

dependencies {
enforcedPlatform("org.projectnessie:nessie-bom:{{ versions.nessie }}")
}
```
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
```
```
A full example using the `nessie-client` artifact:
```kotlin
dependencies {
enforcedPlatform("org.projectnessie.nessie:nessie-bom:{{ versions.nessie }}")
implementation("org.projectnessie.nessie:nessie-client")
}
```

dependencies {
enforcedPlatform("org.projectnessie:nessie-bom:::NESSIE_VERSION::")
}
```
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
```
```
A full example using the `nessie-client` artifact:
```kotlin
dependencies {
enforcedPlatform("org.projectnessie.nessie:nessie-bom:::NESSIE_VERSION::")
implementation("org.projectnessie.nessie:nessie-client")
}
```

In your Gradle project's `build.gradle.kts` add the Nessie BOM as an enforced platform:
```kotlin
dependencies {
enforcedPlatform("org.projectnessie:nessie-bom:::NESSIE_VERSION::")
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
enforcedPlatform("org.projectnessie:nessie-bom:::NESSIE_VERSION::")
enforcedPlatform("org.projectnessie.nessie:nessie-bom:::NESSIE_VERSION::")

<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.projectnessie</groupId>
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
<groupId>org.projectnessie</groupId>
<groupId>org.projectnessie.nessie</groupId>

In your Gradle project's `build.gradle.kts` add the Nessie BOM as an enforced platform:
```kotlin
dependencies {
enforcedPlatform("org.projectnessie:nessie-bom:::NESSIE_VERSION::")
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
enforcedPlatform("org.projectnessie:nessie-bom:::NESSIE_VERSION::")
enforcedPlatform("org.projectnessie.nessie:nessie-bom:::NESSIE_VERSION::")

@@ -21,3 +21,31 @@ img.bordered {
.md-typeset td code {
word-break: revert;
}

Copy link
Member

Choose a reason for hiding this comment

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

Mind adding this as well?

Suggested change
.md-typeset .tabbed-set>.tabbed-content {
padding: 0 .5em 0 .5em;
border: 1px solid #ababab;
border-bottom-left-radius: .3em;
border-bottom-right-radius: .3em;
}

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Quite frankly I don't like it :-D but I added it nonetheless.

margin-right: 2px;
}

.md-typeset .tabbed-set>input:first-child:checked~.tabbed-labels>:first-child,
Copy link
Member

Choose a reason for hiding this comment

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

Oh - I see, it's because of the two distinct sets of elements.

Mind adding a comment that there are two sets of elements? It took me a while to realize that.

@@ -59,20 +62,23 @@ Docker images are multiplatform images for amd64, arm64, ppc64le, s390x.
[Nessie GC](/nessie-nightly/gc/) allows mark and sweep data files based on flexible
expiration policies.

### Docker image
=== "Docker Image"
Copy link
Member

Choose a reason for hiding this comment

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

Looks like the CLI above needs this change as well

@adutra adutra merged commit c648800 into projectnessie:main Jun 28, 2024
18 checks passed
@adutra adutra deleted the site-tabs branch June 28, 2024 07:58
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.

2 participants