bcgov / bcgov/parks-data-register
[M] Let's figure out documentation!
- Dominant language
- JavaScript
- Stars
- 5
- Forks
- 7
- PR merge metrics
- No merged PRs in 30d
Description
This ticket is track work around our team figuring out some new documentation strategies.
**Acceptance Criteria:**
- determine if draw.io (done - see below) , figma (figjam), and/or mural can hook into github for simplicity (eg. updating a diagram so that it automatically updates in github wiki or readme documentation)
- draw diagram to show process
- wiki page created to use by team (done) - https://github.com/bcgov/parks-data-register/wiki/API-Specification#searching-the-data-register
- Draw.io integration with Github (done) - request has been approved (https://github.com/BCDevOps/devops-requests/issues/1598) and tested (https://github.com/bcgov/parks-data-register/commit/a50afe17b9d2a232a6ff28f941786dab7e0af9ac)
- [Team Documentation Guide](https://bcgov.sharepoint.com/:w:/r/teams/08548-DevChannelNew/Shared%20Documents/Dev%20Chat/4.%20Osprey%20Documentation%20Strategy/Osprey%20Documentation%20Guide.docx?d=w4bc66fc60baf4074beab453d5ec20953&csf=1&web=1&e=6qeSSr) (done) - created for team to capture what documentation lives where (document is a living work in progress, expectation is its updated as additional decisions are made by team)
- "Changes During Implementation Process" (done?) - async discussion started on Team Retro channel; further discussion/decisions to take place at Sprint 6 retro (Jan 24th).
- Other?
Contributor guide
No contributing guide indexed for this repository
Research direction
The issue names no source files, tests, or code entry points. Review the remaining acceptance criteria and linked documentation, integration request, commit, and team discussion; done requires deciding and recording any unresolved documentation strategy work.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 15/100