Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create guidance for Cal-ITP on file naming for the web #275

Closed
5 tasks
thekaveman opened this issue Nov 6, 2023 · 1 comment · Fixed by #294
Closed
5 tasks

Create guidance for Cal-ITP on file naming for the web #275

thekaveman opened this issue Nov 6, 2023 · 1 comment · Fixed by #294
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@thekaveman
Copy link
Member

This mostly applies to PDF resources created for hosting on this site.

  • Prefix filenames with Cal-ITP
  • Avoid spaces between words, use dash - or dot . to separate words instead
  • Avoid using characters besides: letters, numbers, dash, dot, and underscore _
  • Avoid using revision dates in filenames, limit usage of revision numbers unless commonly understood and expected by audience
    • Avoid: report-june-2024.pdf, file-v1.3.pdf (random files with versions devoid of context)
    • OK: GTFS-guidelines-v3.pdf (v3 of the GTFS Guidelines, a well-know and ever-evolving document)
  • Shorter is better
@thekaveman thekaveman added the documentation Improvements or additions to documentation label Dec 7, 2023
@thekaveman thekaveman moved this from Todo to Stretch in Digital Services Dec 7, 2023
@machikoyasuda
Copy link
Member

Suggestion: Add each of these as a checklist question to the issue template for resources - https://github.com/cal-itp/calitp.org/blob/main/.github/ISSUE_TEMPLATE/new_resource.yml

Example:

  • Did you start the filename with Cal-ITP?
  • There are no spaces between words in the filename.
  • There are no revision dates in the filename, unless commonly understood and expected by the audience.
  • The only characters in the filename are: letters, numbers, -, . and _.

@machikoyasuda machikoyasuda self-assigned this Dec 15, 2023
@machikoyasuda machikoyasuda moved this from Stretch to In Progress in Digital Services Dec 19, 2023
@machikoyasuda machikoyasuda moved this from In Progress to In Review in Digital Services Dec 19, 2023
@github-project-automation github-project-automation bot moved this from In Review to Done in Digital Services Jan 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants