search

Public-Health-Scotland / technical-docs

Technical documentation, including guidance and best practice for Public Health Scotland (PHS)
https://public-health-scotland.github.io/knowledge-base/docs
5 stars 2 forks source link

REQ - Link to the more detailed PHS Github guidance from the version control guidance on the Knowledge Base #97

Open elizabeth-richardson opened 7 months ago

elizabeth-richardson commented 7 months ago

Is your feature request related to a problem? Please describe. Colleagues have been looking for detailed guidance on setting up and using Github, and the knowledge base documentation wasn't detailed enough for complete beginners. They found the more detailed guidance https://public-health-scotland.github.io/git-guide/ and this was what they needed. But this isn't linked to from the Knowledge Base.

Describe what you'd like A clear link to https://public-health-scotland.github.io/git-guide/ from the version control guidance on the Knowledge Base.

Describe alternatives you've considered Flailing around trying to find guidance in other places. Using GitHub incorrectly. Not using version control. All less satisfactory!

rmccreath commented 3 months ago

The git guide is categorised as a 'textbook', which is linked to from the 'Develop' section in the Knowledge Base here: https://public-health-scotland.github.io/knowledge-base/develop?type=Textbook Agree this isn't obvious and changes could be made to better highlight the different materials available. Have raised on the knowledge-base repo: https://github.com/Public-Health-Scotland/knowledge-base/issues/46