-
Notifications
You must be signed in to change notification settings - Fork 89
drop userguide endpoint (migrate it to github pages) #1829
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
Conversation
0de7da8 to
73dcefc
Compare
anushka-singh
left a comment
There was a problem hiding this 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?
@anushka-singh everything under |
TejasRGitHub
left a comment
There was a problem hiding this 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
anushka-singh
left a comment
There was a problem hiding this 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!
73dcefc to
1a4d5b5
Compare
# 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    # Relates * #1829
TejasRGitHub
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+1
Feature or Bugfix
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 onOWASP 10.
fetching data from storage outside the application (e.g. a database, an S3 bucket)?
evalor similar functions are used?By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.