~exprez135/taliaferro

ref: cfda8f996888359cfefcfd302a70baedfed00305 taliaferro/readme.md -rw-r--r-- 2.3 KiB
cfda8f99 — Nate Ijams Re-organize build scripts, update readme, change git url to sourcehut 1 year, 6 months ago

#The Taliaferro Times Website

#Basic Information

Site: https://thetaliaferrotimes.org

Backup Site: https://taliaferro.tk

Netlify Status

Note: This page is outdated as of April 13th, 2020.

#Developer Information

  1. Posts are made by contributors on their own respective platforms.
  2. Posts are edited by newspaper staff and submitted to the technical officer.
  3. Website design and site indexing are done locally on development computer using Hugo (hugo.sh).
  4. Git added, committed, tagged, and pushed to GitLab & SourceHut. GitLab push causes Netlify build to taliaferro.tk.
  5. Once changes are confirmed, dev runs deploy-remote.sh script which causes newspaper server to pull from repository and deploy the new site.
  6. Made public.

See manual.md for an overview of how the website works. See each file in the repository for in-line documentation on the purpose of the file and each item within.

What else does hosting on GitLab/SourceHut mean? If the newspaper were to lose funding or access to a dedicated provider, it would be a simple matter of setting up GitLab Pages on the repository. Also, the entire site and its generation technique can be easily ported from system to system, site to site, provider to provider.

#Versioning

We use something similar to the Semantic Versioning System: MAJOR.MINOR.PATCH

  • MAJOR: Major release (new features which significantly change the site). Examples: radical new design, new search function, lots of small changes together.
  • MINOR: Small releases which add minor features or content. Examples: new post on site, little design changes, big edits to a page like About.
  • PATCH: Minor changes which fix a problem. Examples: fix a problem with a recent change or design, typos, link issues, etc.

To-do:

  • [x] Privacy-respecting analytics (Matomo) - Solution: GoatCounter
  • [ ] Finish manual.md
  • [ ] Add in-line documentation to all relevant files
  • [ ] Update Privacy Policy
  • [ ] Update About page
  • [ ] Use .webp files for supported browsers
  • [ ] Social media bar
  • [x] Footer: copyright notice, editorial notice, Privacy, Wordpress, Status

Far-off goals:

  • [ ] Automated means of sending social media & email newsletter notices when new content is posted.