forked from solene/openbsd-webzine
Repository of the OpenBSD Webzine
dev | ||
issues | ||
public | ||
LICENSE | ||
README.md | ||
TODO |
openbsd-webzine
Repository of the OpenBSD Webzine
Worflow
Everything related to writing a new issue is in issues
.
New issue
- Copy
_template
directory under a name likeissue-X
withX
being the new issue number. - Delete the symlink
current
and make it with the new issue as a target.
Edit an issue
- cd into
issues/current/
and edit files as you need. 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 in~/Downloads
and open it in a web browser
Contributing
Anyone can contribute by doing this:
- English proofreading
- Translation into other languages
- Content contribution
There are many methods for contributing, here is the list by order of preference (more easier to handle):
- make an account on tildegit, fork the project, create a new branch with changes and send us Merge Requests (it's easy once you get how this work. See "Git usage below").
- 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. - send a simple diff to a contributor.
- open an issue.
- speak on IRC / XMPP / mail.
What content?
For each issue we will try to write about these topics:
- jobs offers related to OpenBSD (if any)
- big changes landing in current
- syspatch and digest of packages updates in -stable
- developer or professionals using OpenBSD interviews (if any)
- tips about shell or OpenBSD
- comments from readers
- links to OpenBSD content
- one piece of artwork
- a few interesting links to social medias
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 a merge request : Menu > Projects > Merge request tab > New request button