Skip to content

Docs: better visibility for OSS vs Enterprise features #9132

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
Merged
merged 5 commits into from
Jun 3, 2025
Merged

Docs: better visibility for OSS vs Enterprise features #9132

merged 5 commits into from
Jun 3, 2025

Conversation

ozkatz
Copy link
Collaborator

@ozkatz ozkatz commented Jun 2, 2025 •
edited
Loading

Avoid confusion in the lakeFS docs by highlighting which pages are relevant to OSS (default) vs lakeFS Enterprise features. This serves 2 purposes:

  1. Allow OSS users to quickly figure out which pages are relevant for them and which aren't
  2. Allow people interested in learning about Enterprise features to more easily find relevant documentation

Example:

image

@ozkatz ozkatz requested review from nopcoder and talSofer June 2, 2025 15:10
@ozkatz ozkatz self-assigned this Jun 2, 2025
@ozkatz ozkatz added docs Improvements or additions to documentation exclude-changelog PR description should not be included in next release changelog minor-change Used for PRs that don't require issue attached labels Jun 2, 2025
@github-actions GitHub Actions
Copy link

github-actions bot commented Jun 2, 2025 •
edited
Loading

♻️ PR Preview 578ac22 has been successfully destroyed since this PR has been closed.

🤖 By surge-preview

nopcoder
nopcoder requested changes Jun 2, 2025
View reviewed changes
Copy link
Contributor

@nopcoder nopcoder left a comment •
edited
Loading

Choose a reason for hiding this comment

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

When rendered it seems there is a small difference in color between collapse level and leaf.

image

Also, do we like to label Cloud too when its supported?
If the badge is too long "C" and "E" badge with tooltip or information at the footer will work too.

@ozkatz ozkatz requested a review from nopcoder June 2, 2025 20:27
nopcoder
nopcoder approved these changes Jun 2, 2025
View reviewed changes
Copy link
Contributor

@nopcoder nopcoder left a comment

Choose a reason for hiding this comment

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

Thanks!

talSofer
talSofer approved these changes Jun 3, 2025
View reviewed changes
Copy link
Contributor

@talSofer talSofer left a comment

Choose a reason for hiding this comment

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

Thanks! added a non-blocking suggestion

docs/howto/lakefs-tables.md Outdated
@@ -2,6 +2,9 @@
title: lakeFS Tables
description: Use lakeFS to manage Iceberg Tables using a builtin Iceberg REST Catalog
parent: How-To
badges:
- name: Enterprise
display_name: ENT
Copy link
Contributor

Choose a reason for hiding this comment

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

Non blocking but I think that using Enterprise as display name is clearer

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Agree - fixed

@ozkatz ozkatz force-pushed the docs/enterprise-visibility branch from 2867429 to 578ac22 Compare June 3, 2025 21:46
@ozkatz ozkatz merged commit 3a66572 into master Jun 3, 2025
42 checks passed
@ozkatz ozkatz deleted the docs/enterprise-visibility branch June 3, 2025 22:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nopcoder nopcoder nopcoder approved these changes

@talSofer talSofer talSofer approved these changes

Assignees

@ozkatz ozkatz

Labels
docs Improvements or additions to documentation exclude-changelog PR description should not be included in next release changelog minor-change Used for PRs that don't require issue attached
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@ozkatz @nopcoder @talSofer