Repository of the OpenBSD Webzine
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
solene 4cf12a6982 Merge pull request 'Add interview for third issue + links' (#36) from vinishor/openbsd-webzine:main into main 17 hours ago
dev force existence of directories 4 weeks ago
issues Complete interview (part2) + Add a link present in IDEAS 1 day ago
public delete files in public/ 3 weeks ago
.gitignore add a gitignore file to avoid dev/ and public/ directories 3 weeks ago
LICENSE Switch to license CC-BY 4.0 4 weeks ago
README.md Add a URL to the OpenBSD Webzine 3 weeks ago
TODO screen readers don't read puffy emoji 3 weeks ago

README.md

openbsd-webzine

Repository of the OpenBSD Webzine

Workflow

Everything related to writing a new issue is under issues directory.

New issue

  • copy _template directory under a name like issue-X with X being the new issue number
  • delete the symlink current and recreate it with the new issue as the target

I.e.

$ cd issues
$ cp -r _template issue-3
$ ln -fs issue-3 current

Edit an issue

  • cd into issues/current/ and edit files as needed
  • categories that are empty should be commented out using HTML comments
  • when you recreate the issues with make, the one in development is generated in ../dev/
  • use make test to automatically copy the current issue to /tmp/openbsd-webzine directory and open it in a web browser

Contributing

Anyone can contribute by doing the following:

  • English proofreading
  • translation into other languages
  • content contribution

There are many ways to contribute - here is a list by order of preference (easier to handle):

  1. make an account on tildegit, fork the project, create a new branch with changes, and send us Pull Requests (it's easy once you get how this work - see "Git usage" below)
  2. make a local commit from a freshly updated cloned repository and use git format-patch to send an email to a contributor (currently solene) so your commit can be merged into the repository easily
  3. send a simple diff to a contributor
  4. open an issue
  5. speak on IRC / XMPP / email

What content?

For each issue we will try to write about these topics:

  • job offers related to OpenBSD (if any)
  • big changes landing in -current
  • syspatch and digest of package updates in -stable
  • interviews with developers or professionals using OpenBSD (if any)
  • tips about shell or OpenBSD
  • comments from readers
  • links to OpenBSD content
  • a piece of artwork
  • a few interesting links to social media

Git usage

Fork this project and clone your own fork, then add the upstream repo.

$ git clone git@tildegit.org:foo/openbsd-webzine.git
$ cd openbsd-webzine
$ git remote add upstream https://tildegit.org/solene/openbsd-webzine.git

Keep your fork sync with upstream.

$ git pull upstream main

You can now edit files.

At last, add modified files and commit:

$ git add issue-*/
$ git commit -m "message"
$ git push

You can now ask for your Pull Request to get merged.