Added documentation for licenses in lakeFS Enterprise to the public docs #9270

Annaseli · 2025-07-08T12:28:15Z

Closes #9269

Added licensing documentation for lakeFS Enterprise to the public docs.
Note that most of the content is collapsed within toggle boxes (using ??? info) to improve readability by hiding additional details, which users can expand as needed.
Added missing links to the “Install” documentation page.
Applied additional styling to the page.

github-actions · 2025-07-08T12:28:56Z

📚 Documentation preview at https://pr-9270.docs-lakefs-preview.io/

(Updated: 7/17/2025, 11:40:11 PM - Commit: 6a9e33f)

N-o-Z

Added my 2 cents.
However I think the final decision should be by product

docs/src/enterprise/getstarted/install.md

N-o-Z · 2025-07-10T12:45:00Z

@Annaseli General comment - we do not add the include-changelog label for changes in documentation, tests or infrastructure. (You can find the guideline in the lakeFS release document

arielshaqed

A lot of this is really weird Markdown. Confused but not blocking.

arielshaqed · 2025-07-16T08:22:40Z

docs/src/enterprise/getstarted/install.md

@@ -3,16 +3,15 @@ title: Install
 description: lakeFS Enterprise Installation Guide
 ---

-# Install
+# **Install**


I don't understand why we try to add styles to markdown headings like this. In fact, AFAIK:

There should be no difference between the appearance of these two style, the first should be <h1>Install</h1> and the second should be <h1><b>Install</b></h1>. These are generally styled the same. Similarly for ##.

Other headers in our docs do not receive this treatment.

Why are these headings different?

This is what these headings look like on the preview:

On FF, h1 appears less bold than h2. We may have a CSS problem, but let's not fix it separately on each page.

@arielshaqed
Got it, I’ve reverted the change.
I thought the bold headings improved readability and overall appearance, which is why I made the adjustment. However, I agree it’s not ideal to apply this styling change on a single page only.

Before my modification, this is how it looked in Chrome:

After my modification, it appeared like this in Chrome:

docs/src/enterprise/getstarted/install.md

…nse requirement just below the ### lakeFS Enterprise License title.

ozkatz

Mostly great! I love the troubleshooting section :)

Some markdown nitpicks that if addressed, could make the page more accessible and allow for hot linking to specific sections.

docs/src/enterprise/getstarted/install.md

ozkatz · 2025-07-16T17:14:34Z

docs/src/enterprise/getstarted/install.md

+    > **Note**: The token can be decoded using any JWT decoding tool to view the license information.
+
+??? question "Troubleshooting"
+    - **Server Won't Start**


Instead of a list, use ##### (h5) or ###### (h6) - will not show up in the TOC but will be hot-linkable.

@ozkatz
Got it, when using the h5 heading, it looks like this:

and the title does appear in the TOC:

When using the h6 heading, it looks like this: and the title does not appear in the TOC.

I think the h5 is better, what do you think?

ozkatz

Thanks! Looks great.

My comments are mostly Markdown styling. It's better to use semantic headings over styling regular text to look like a header. If we're unhappy with how headings look, let's use semantic markdown and improve styles in CSS! Better for accessibility and easier to read and maintain.

ozkatz · 2025-07-17T20:49:23Z

docs/src/enterprise/getstarted/install.md

+#### **Licensed Features**
+The following lakeFS Enterprise features must be included in the lakeFS Enterprise license in order to be available:
+
+<u>Authentication & Authorization</u>


Suggested change

<u>Authentication & Authorization</u>

##### Authentication & Authorization

ozkatz · 2025-07-17T20:49:40Z

docs/src/enterprise/getstarted/install.md

+- [SCIM (System for Cross-domain Identity Management)](../../howto/scim.md)
+- [IAM (Identity and Access Management) Role Authentication](../../security/external-principals-aws.md)
+
+<u>Advanced Functionality</u>


Suggested change

<u>Advanced Functionality</u>

##### Advanced Functionality

ozkatz · 2025-07-17T20:49:50Z

docs/src/enterprise/getstarted/install.md

+lakeFS Enterprise server and paid features. A license is tied to a specific installation via an installation ID, and to 
+a specific organization via an organization ID.
+
+<br>


Suggested change

<br>

ozkatz · 2025-07-17T20:51:02Z

docs/src/enterprise/getstarted/install.md

+3. <u>Configure lakeFS Enterprise Server</u>  
+    1. Save the license token to a file.  
+    2. Provide the file path in the lakeFS Enterprise configuration file:
+


Suggested change

ozkatz · 2025-07-17T20:51:27Z

docs/src/enterprise/getstarted/install.md

+    }
+    ```
+
+    > **Note**: The token can be decoded using any JWT decoding tool to view the license information.


Suggested change

> **Note**: The token can be decoded using any JWT decoding tool to view the license information.

The returned token can be decoded using any JWT decoding tool to view the license information.

ozkatz · 2025-07-17T20:51:36Z

docs/src/enterprise/getstarted/install.md

+
+    > **Note**: The token can be decoded using any JWT decoding tool to view the license information.
+
+<br>


Suggested change

<br>

ozkatz · 2025-07-17T20:51:53Z

docs/src/enterprise/getstarted/install.md

+<br>
+
+#### **License Monitoring & Updates**
+<u>Updating Your License</u>


Suggested change

<u>Updating Your License</u>

##### Updating Your License

ozkatz · 2025-07-17T20:52:15Z

docs/src/enterprise/getstarted/install.md

+- <u>Validation and Expiry Check:</u> Occurs periodically to verify license validity and expiry.
+- <u>File Monitoring:</u> The server checks periodically to detect license file changes so that when the license token gets updated in the file, there is no need to restart the server and the license updates automatically.
+
+<br>


Suggested change

<br>

ozkatz · 2025-07-17T20:52:30Z

docs/src/enterprise/getstarted/install.md

+
+<br>
+
+#### **License Monitoring & Updates**


Suggested change

#### **License Monitoring & Updates**

#### License Monitoring & Updates

ozkatz · 2025-07-17T20:52:41Z

docs/src/enterprise/getstarted/install.md

+
+<br>
+
+#### **Troubleshooting**


Suggested change

#### **Troubleshooting**

#### Troubleshooting

Annaseli · 2025-07-17T23:12:01Z

Thanks! Looks great.

My comments are mostly Markdown styling. It's better to use semantic headings over styling regular text to look like a header. If we're unhappy with how headings look, let's use semantic markdown and improve styles in CSS! Better for accessibility and easier to read and maintain.

@ozkatz
ok, yes, I think it's a good idea to improve our CSS for styling the headings in the docs. I'll look into it next week.

Annaseli added 2 commits July 7, 2025 23:01

Added licensing documentation to the public docs.

7387d82

Edited the licensing documentation to the public docs.

28db22b

Annaseli requested review from ozkatz and a team July 8, 2025 12:28

Annaseli changed the title ~~Added documentation for licenses in lakeFS Enterprise to the docs~~ Added documentation for licenses in lakeFS Enterprise to the public docs Jul 8, 2025

Annaseli added include-changelog PR description should be included in next release changelog exclude-changelog PR description should not be included in next release changelog and removed exclude-changelog PR description should not be included in next release changelog labels Jul 8, 2025

N-o-Z reviewed Jul 9, 2025

View reviewed changes

Addressed comments on the PR.

7cc241f

N-o-Z added exclude-changelog PR description should not be included in next release changelog and removed include-changelog PR description should be included in next release changelog labels Jul 10, 2025

Fixed the [lakefs-sso-enterprise-spec-saml] link

a6e35e4

arielshaqed reviewed Jul 16, 2025

View reviewed changes

Removed bold styling from headings and added a warning about the lice…

cad7b41

…nse requirement just below the ### lakeFS Enterprise License title.

Annaseli requested review from N-o-Z and arielshaqed July 16, 2025 15:35

merged master to my branch

5e62b25

ozkatz requested changes Jul 16, 2025

View reviewed changes

Restructured document appearance

6499255

Annaseli requested a review from ozkatz July 17, 2025 12:28

Replaced bold with <u>..</u>

3e80679

ozkatz approved these changes Jul 17, 2025

View reviewed changes

Cleaned markdown styles

6a9e33f

Annaseli merged commit d677e6b into master Jul 17, 2025
42 checks passed

Annaseli deleted the docs/add-documentation-for-licenses-in-docs branch July 17, 2025 23:39

	<u>Authentication & Authorization</u>
	##### Authentication & Authorization

	> Note: The token can be decoded using any JWT decoding tool to view the license information.
	The returned token can be decoded using any JWT decoding tool to view the license information.


		> Note: The token can be decoded using any JWT decoding tool to view the license information.

		<br>

	#### License Monitoring & Updates
	#### License Monitoring & Updates

Added documentation for licenses in lakeFS Enterprise to the public docs #9270

Added documentation for licenses in lakeFS Enterprise to the public docs #9270

Uh oh!

Conversation

Annaseli commented Jul 8, 2025

Uh oh!

github-actions bot commented Jul 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

N-o-Z left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

N-o-Z commented Jul 10, 2025

Uh oh!

arielshaqed left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Annaseli Jul 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ozkatz left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Annaseli Jul 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ozkatz left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Annaseli commented Jul 17, 2025

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Jul 8, 2025 •

edited

Loading

Annaseli Jul 16, 2025 •

edited

Loading

Annaseli Jul 17, 2025 •

edited

Loading