-
Notifications
You must be signed in to change notification settings - Fork 3
docs: jobs revamp #62
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
base: main
Are you sure you want to change the base?
Conversation
Merge branch 'main' of https://github.com/Hii-Arpit/devtron-documentation into job-revamp
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.
I am yet to review this PR now that main has merged with it, tagging myself @ashokdevtron
…tion into job-revamp merge main
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.
Pull Request Overview
This PR implements a comprehensive documentation revamp for the Jobs feature in Devtron. The update restructures the entire Jobs documentation with improved organization, enhanced content, and better user guidance through the job creation and management workflow.
Key changes include:
- Complete reorganization of documentation structure with new directory hierarchy
- Addition of comprehensive guides for job creation, configuration, and management
- Enhanced content with detailed examples, use cases, and step-by-step instructions
Reviewed Changes
Copilot reviewed 16 out of 16 changed files in this pull request and generated no comments.
Show a summary per file
File | Description |
---|---|
docs/user-guide/jobs/workflow-editor-job.md |
Removed old workflow editor documentation |
docs/user-guide/jobs/what-is-job.md |
Added new introductory page explaining Jobs concept and use cases |
docs/user-guide/jobs/triggering-job.md |
Enhanced job triggering documentation with detailed steps and UI guidance |
docs/user-guide/jobs/run-history-job.md |
Added comprehensive run history documentation with execution details |
docs/user-guide/jobs/overview-job.md |
Expanded overview page with About section, tags management, and catalog features |
docs/user-guide/jobs/create-job.md |
Enhanced job creation guide with blank and clone job workflows |
docs/user-guide/jobs/configurations/workflow-editor-job.md |
Added detailed workflow editor documentation with task examples |
docs/user-guide/jobs/configurations/source-code-job.md |
Added source code configuration documentation |
docs/user-guide/jobs/configurations/environment-override-job.md |
Added environment override configuration guide |
docs/user-guide/jobs/configurations/configmap-secret/secret-job.md |
Added comprehensive secrets configuration documentation |
docs/user-guide/jobs/configurations/configmap-secret/configmap-job.md |
Added detailed ConfigMaps configuration guide |
docs/user-guide/jobs/configurations/configmap-secret/README.md |
Added ConfigMaps & Secrets overview |
docs/user-guide/jobs/configurations/README.md |
Added configurations overview page |
docs/user-guide/jobs/configuration-job.md |
Removed old configuration documentation |
docs/user-guide/jobs/README.md |
Updated main Jobs page with new structure |
docs/SUMMARY.md |
Updated table of contents to reflect new documentation structure |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
️✅ There are no secrets present in this pull request anymore.If these secrets were true positive and are still valid, we highly recommend you to revoke them. 🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request. |
docs: jobs revamp
Quick Preview (updated)