~exprez135/taliaferro

The Taliaferro Times ~ the official school newspaper and creative writing club of Booker T. Washington High School

39c01a0 Add Netlify CMS

3 months ago

7767196 Add Netlify CMS

3 months ago

#The Taliaferro Times Website

#Basic Information

Site: https://thetaliaferrotimes.org

Backup Site: https://taliaferro.tk

Netlify Status

This is the site repository for The Taliaferro Times, the official newspaper and creative writing club of Booker T. Washington High School. All of the source code for the site is within this repository and its submodules.

We use Hugo, a static site generator, to generate a complete static site from HTML/Go template files and content files written in Markdown. Our site is powered by Netlify.

See COPYING for information on how you can use our content and code. See MANUAL.md for an introduction to the format and code of the site.

#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.
  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 deployment 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, totally new search function, lots of minor 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, changes which most users won't see or notice.
  • PATCH: Minor changes which fix a problem. Examples: fix a problem with a recent change or design, typos, link issues, etc.

#Contributing & Bug Reporting

File issues at https://todo.sr.ht/~exprez135/Taliaferro.

Read our About page and our Code of Conduct.

#Dependencies, Resources, and More

#Behind the Scenes

  • Hugo: generate site
  • Git: version control
  • Modified version of "HugoLunr" by Hugo Di Francesco. Uses:
    • Node.js: to generate our search index. Uses the following packages (see package.json):
      • Lunr.js: search
      • parser-front-matter: parse our YAML front matter in posts
      • readdirp: like readdir, but reads directories recursively
      • Other Dependencies: see node_modules directory.

#With the Reader

#License

See COPYING.txt. Summary:

  • Code: by various authors; all MIT license except DarkReader.js (Apache License 2.0)

  • Written Content: by the various contributors to The Taliaferro Times; CC BY-SA 4.0

  • Fonts: SIL OFL 1.1 except Charter fonts (custom Bitsream Inc. license)

  • Icons & Images: by FontAwesome and various photographers; CC BY 4.0 (Unsplash) & CC BY-SA 4.0 (newspaper photographers)