search

department-of-veterans-affairs / va.gov-team

Public resources for building on and in support of VA.gov. Visit complete Knowledge Hub:
https://depo-platform-documentation.scrollhelp.site/index.html
283 stars 204 forks source link

Please update list of prohibited characters in Git file names #95548

Open JonathanKamensDVA opened 2 weeks ago

JonathanKamensDVA commented 2 weeks ago

Description

I know this is my fault because I'm the one who suggested the list of prohibited characters we should document for git file names, but it turns out I missed a few. Can we add them to the documentation please?

Relevant URLs

Page to update: https://depo-platform-documentation.scrollhelp.site/getting-started/adding-files-to-the-github-repository Reference list of all prohibited characters: https://stackoverflow.com/a/31976060

Which type of team are you on? (Platform team, VFS team, or Leadership)

Leadership

jknipes commented 1 week ago

Hi @JonathanKamensDVA , thanks for your content suggestions. The Platform Content team will review your request and put it in our backlog to refine for next steps.

jknipes commented 1 week ago

@JonathanKamensDVA in order to create a work ticket for this edit, we need to parse out just the info that will be added to the Platform website page.

Would you be able to put that into a comment here or perhaps attach a document with the info?

JonathanKamensDVA commented 15 hours ago

Right now the platform docs page says to avoid question marks, colons, and pipe symbols; to avoid file names ending with a space or period or starting with a space; and to avoid long file paths because of the 256-character file path limit on Windows.

The information shown in italics in the previous paragraph is what needs to be updated. The list of characters to avoid needs to be expanded. It should include: forward and back slashes (/, \), less and greater than signs (<, >), colons (:), double quotes ("), pipe symbols (|), question marks (?), and asterisks (*).