DSACMS / DSACMS/ospo

Convert VDI Environment Installation Instructions to Markdown

Open
#36 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Shell
Stars
1
Forks
0
PR merge metrics
No merged PRs in 30d

Description

## MENTOR
- @natalialuzuriaga, @DinneK
- Software Engineers, CMS OSPO, VDI Python Environment
- #dsac-ospo on slack

## BRIEF DESCRIPTION
The VDI Python Environment team is working with the OSPO to shift over their package & VScode extension review workflow to a repository in CMS' internal GitHub (github.cms.gov). As part of documentation, we would like to include a file in the repository with . Currently, this is in the form of a .docx file. We would like to make this a markdown file so the instructions instantly viewable upon visiting the repo (vs having to download the docx file everytime).

More details on this ticket here: https://github.cms.gov/DSAC/ospo/issues/722

## SCOPING
1 day

## SKILLS NEEDED
Git, Markdown, Documentation

## REQUIRED DELIVERABLES
Convert over contents of .docx installation guide to a new markdown file called `INSTALL.md` . Create a PR with this change and mentors will review!

## DESIRED DELIVERY WINDOW
- June

## NOTES/INSPO
For those who would like to practice their Git skills, markdown skills, and documentation.

# ACKNOWLEDGEMENTS
- [X] - Yes, I agree to spend file a project proposal ticket
- [X] - Yes, I agree this project falls within a 2 week or less (ideally less) scope of time
- [X] - Yes, I agree to spend an hour per week of office hours and 1x1 mentoring
- [X] - Yes, I agree to spend an hour at the end of the sprint for filling out a Retro Template

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.