WIP: restructure docs navigation #9200
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ozkatz
added
docs
|
📚 Documentation preview at https://pr-9200.docs-lakefs-preview.io/ |
nopcoder
reviewed
Jun 19, 2025
| @@ -121,129 +125,136 @@ nav: | |||
| - "6\uFE0F\u20E3 Using Actions and Hooks in lakeFS": quickstart/actions-and-hooks.md | |||
There was a problem hiding this comment.
can remove "in lakeFS" all items in quick start are lakeFS steps
Comment on lines
+59
to
+84
| !!! example | ||
| ```yaml | ||
| blockstores: | ||
| signing: | ||
| secret_key: "some-secret" | ||
| stores: | ||
| - id: "minio-prod" | ||
| description: "Primary on-prem MinIO storage for production data" | ||
| type: "s3" | ||
| s3: | ||
| force_path_style: true | ||
| endpoint: 'http://minio-prod.local' | ||
| discover_bucket_region: false | ||
| credentials: | ||
| access_key_id: "prod_access_key" | ||
| secret_access_key: "prod_secret_key" | ||
| - id: "minio-backup" | ||
| description: "Backup MinIO storage for disaster recovery" | ||
| type: "s3" | ||
| s3: | ||
| force_path_style: true | ||
| endpoint: 'http://minio-backup.local' | ||
| discover_bucket_region: false | ||
| credentials: | ||
| access_key_id: "backup_access_key" | ||
| secret_access_key: "backup_secret_key" |
There was a problem hiding this comment.
looks like there is indent issue for each item in the stores like.
suggest to use tab=2 spaces and push each level after each "- id:"
Comment on lines
+95
to
+106
| stores: | ||
| - id: "s3-prod" | ||
| description: "AWS S3 storage for production data" | ||
| type: "s3" | ||
| s3: | ||
| region: "us-east-1" | ||
| - id: "azure-analytics" | ||
| description: "Azure Blob storage for analytics data" | ||
| type: "azure" | ||
| azure: | ||
| storage_account: "analytics-account" | ||
| storage_access_key: "EXAMPLE45551FSAsVVCXCF" |
| type: "s3" | ||
| s3: | ||
| force_path_style: true | ||
| endpoint: 'http://minio.local' |
|
|
||
| ## What security features does lakeFS Enterprise provide? | ||
|
|
||
| With lakeFS Enterprise you’ll receive access to the security package containing the following features: | ||
|
|
||
| 1. A rich [Role-Based Access Control](../security/rbac.md) permission system that allows for fine-grained control by associating permissions with users and groups, granting them specific actions on specific resources. This ensures data security and compliance within an organization. | ||
| 2. To easily manage users and groups, lakeFS Enterprise provides SSO integration (including support for SAML, OIDC, ADFS, Okta, and Azure AD), supporting existing credentials from a trusted provider, eliminating separate logins. | ||
| 1. To easily manage users and groups, lakeFS Enterprise provides SSO integration (including support for SAML, OIDC, ADFS, Okta, and Azure AD), supporting existing credentials from a trusted provider, eliminating separate logins. | ||
| 3. lakeFS Enterprise supports [SCIM](../howto/scim.md) for automatically provisioning and deprovisioning users and group memberships to allow organizations to maintain a single source of truth for their user database. |
There was a problem hiding this comment.
Suggested change
| 3. lakeFS Enterprise supports [SCIM](../howto/scim.md) for automatically provisioning and deprovisioning users and group memberships to allow organizations to maintain a single source of truth for their user database. | |
| 1. lakeFS Enterprise supports [SCIM](../howto/scim.md) for automatically provisioning and de-provisioning users and group memberships, enabling organizations to maintain a single source of truth for their user database. |
Comment on lines
+8
to
+9
| 1. lakeFS Cloud | ||
| 2. lakeFS Enterprise |
There was a problem hiding this comment.
General note about our "lakeFS Enterprise" - do people understand that what we call Enterprise is on-prem? There are a many solution where the two are not the same.
Comment on lines
+255
to
+259
| - The lakeFS Project: | ||
| - About: project/index.md | ||
| - Contributing to lakeFS: | ||
| - Code: project/contributing.md | ||
| - Documentation: project/docs.md |
There was a problem hiding this comment.
Looking for a different section name as I expected the information about lakeFS as part of the first items in the nav.
- Community
- Contributing
- Code Contributions
- Documentation
- About the Project
- Contributing
nopcoder
reviewed
Jun 19, 2025
| | **[Role Based Access Control (RBAC)](../security/rbac.md)** | | ✅ | | ||
| | **[Single Sign On (SSO)](../security/sso.md)** | | ✅ | | ||
| | **[SCIM Support](../howto/scim.md)** | | ✅ | | ||
| | **[IAM Roles](../security/external-principals-aws.md)** | | ✅ | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Still in progress - looking to simplify the navigation tree in the docs, making it more accessible for those starting out and those looking for advanced functionality.