CSPL-4237 improve GitHub page #1615
Merged
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
- Introduced a GitHub Actions workflow for previewing documentation changes. - Added configuration files for Jekyll-based documentation site. - Created a .gitignore file for the docs directory to exclude build artifacts. - Updated multiple documentation files with front matter for better organization and navigation. - Enhanced existing documentation with additional sections on deployment, health checks, and security considerations.
Collaborator
Author
|
Converted to draft, because the github action I added probably won't work - need to check it again |
- Added permission for pull-requests to the workflow. - Implemented a step to comment the preview URL on pull requests after deployment.
Collaborator
Pull Request Test Coverage Report for Build 19504519773Details
💛 - Coveralls |
Collaborator
Pull Request Test Coverage Report for Build 19500733178Details
💛 - Coveralls |
- Adjusted concurrency group to remove fallback to run_id. - Added environment configuration for GitHub Pages deployment. - Removed conditional check for commenting preview URL on pull requests.
kubabuczak
temporarily deployed
to
github-pages
GitHub Actions
Inactive
It wasn't working properly (it was overwriting published page)
…ate Examples.md with kubectl command for decoding secrets. This enhances the development workflow for documentation and provides clearer instructions for users.
Collaborator
Author
|
Decided to remove workflow for preview, as it's not working as expected. Currently published page: https://splunk.github.io/splunk-operator/ 
|
rlieberman-splunk
approved these changes
Nov 19, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Description
This PR enhances the Splunk Operator documentation infrastructure by introducing a Jekyll-based documentation site with GitHub Pages support
and a preview workflowfor documentation changes.Key Changes
GitHub Actions & Jekyll Setup- Added docs-preview.yml workflow for automatic documentation preview in PRs- Created docs/_config.yml for Jekyll site configuration (theme, search, navigation)- Added docs/Gemfile for Ruby/Jekyll dependencies and docs/.gitignore for build artifactsDocumentation Structure
Documentation Updates
Testing and Verification
Documentation preview workflow triggers on pull requests targeting documentation filesRelated Issues
CSPL-4237
PR Checklist