Skip to content

Conversation

@petrkalos
Copy link
Contributor

Feature or Bugfix

  • Refactoring

Detail

drop userguide endpoint and move it to github pages

Relates

Security

Please answer the questions below briefly where applicable, or write N/A. Based on
OWASP 10.

  • Does this PR introduce or modify any input fields or queries - this includes
    fetching data from storage outside the application (e.g. a database, an S3 bucket)?
    • Is the input sanitized?
    • What precautions are you taking before deserializing the data you consume?
    • Is injection prevented by parametrizing queries?
    • Have you ensured no eval or similar functions are used?
  • Does this PR introduce any functionality or component that requires authorization?
    • How have you ensured it respects the existing AuthN/AuthZ mechanisms?
    • Are you logging failed auth attempts?
  • Are you using or adding any cryptographic features?
    • Do you use a standard proven implementations?
    • Are the used keys controlled by the customer? Where are they stored?
  • Are you introducing any new policies/roles/users?
    • Have you used the least-privilege principle? How?

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

Copy link
Collaborator

@anushka-singh anushka-singh left a comment

Choose a reason for hiding this comment

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

This looks good in an initial glance. Are there any particular files we must be reviewing critically?

@petrkalos
Copy link
Contributor Author

This looks good in an initial glance. Are there any particular files we must be reviewing critically?

@anushka-singh everything under deploy/ should be reviewed, deletion of the documentation/ files are not because they were simply moved to the gh pages (see the other PR mentioned in the description)

@petrkalos petrkalos marked this pull request as ready for review June 27, 2025 08:45
Copy link
Collaborator

@TejasRGitHub TejasRGitHub left a comment

Choose a reason for hiding this comment

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

Looks good . Added few comments

Copy link
Collaborator

@anushka-singh anushka-singh left a comment

Choose a reason for hiding this comment

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

+1

Reviewed all the backend files under deploy/ - everything looks good.
Checked for other mentions of userguide that could be deleted, but found none apart from the ones in this PR. I think we are good to go!

@petrkalos petrkalos force-pushed the feature/drop_userguide branch from 73dcefc to 1a4d5b5 Compare July 3, 2025 08:38
petrkalos added a commit that referenced this pull request Jul 3, 2025
# Enhanced Documentation Site with Improved Navigation and User
Experience

## Key Changes
- **New Sidebar Navigation**: Added comprehensive sidebar with dropdown
menus and arrow indicators for better content organization
- **Search Functionality**: Implemented search bar with
JavaScript-powered content search
- **Table of Contents**: Added TOC component for improved page
navigation
- **UI Improvements**: Fixed logo aspect ratio and enhanced visual
elements
- **Complete User Guide**: Added extensive documentation covering all
major features (164 files changed, 3,569 insertions)

## Major Additions
- Sidebar navigation system with collapsible sections
- Search functionality across documentation
- User guide sections for environments, datasets, shares, security,
monitoring, and more
- 100+ new images and screenshots for better documentation
- Responsive design improvements

## Technical Changes
- New CSS/JS assets for sidebar and search functionality
- Updated layout templates for better structure
- Improved mobile responsiveness
- Enhanced external link handling

This update transforms the documentation from a basic site into a
comprehensive, navigable user guide with modern UX patterns.

## Screenshots

![image](https://github.com/user-attachments/assets/f758c6bd-e0b2-44d9-b3eb-cd1e8a93b525)


![image](https://github.com/user-attachments/assets/ed121b13-2a7c-40cc-ba13-9fdbac0e23d1)


![image](https://github.com/user-attachments/assets/e46d135c-fb2c-4c9f-9c91-6b1c651966f8)

# Relates

* #1829
Copy link
Collaborator

@TejasRGitHub TejasRGitHub left a comment

Choose a reason for hiding this comment

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

+1

@petrkalos petrkalos merged commit 34799e8 into main Jul 3, 2025
14 checks passed
@petrkalos petrkalos deleted the feature/drop_userguide branch July 3, 2025 13:44
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.

3 participants