bcgov / bcgov/bcstats-ses

README/how-to updates

Open
#40 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
R
Stars
0
Forks
0
Avg merge
34m
Merged PRs (30d)
4

Description

I think either a README update is needed, or some documentation stored on the LAN indicating exactly how to use this repo. Basically some step-by-step instructions on what an analyst would need to do to create/update the index next year. Which scripts need to be run when? What data needs to be imported into the SRE? Probably something on the LAN? (Maybe this would be better as a Jira ticket than as a GitHub issue, but it's partially related to needing to update this README).

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the README and the repository's scripts to map how an analyst creates or updates the index. Document which scripts run when, what data must be imported into the SRE, and whether the instructions belong in the README or on the LAN; it is done when next year's workflow is step-by-step and actionable.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.