bcgov / bcgov/cas-reporting

Document attachment scanning job command

Open
#698 1 comment 0 reactions 0 assignees View on GitHub
attn: Devs BACKLOG DevOps Task
Dominant language
No language data
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Description

#### Describe the task

Our cronjob in `check-file-status.yaml` uses a scary and complex bash command, it would be good to document what it does and what the arguments mean, so that a developer with no prior knowledge can understand what's happening

#### Acceptance Criteria

- [ ] first
- [ ] second
- [ ] third

#### Definition of Done

- [ ] first
- [ ] second
- [ ] third

#### Additional context

- Add any other context about the task here.
- Or here

Contributor guide

No contributing guide indexed for this repository

Research direction

Open check-file-status.yaml and inspect the cronjob command and its arguments. Document what the command does and what each argument means so a developer without prior knowledge can understand it; the generic acceptance criteria need to be clarified before completion can be verified.

Written by the indexing model from the issue text.

Assessment

Tech stack
bash
Domain
devops, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.