Merge git.anarchyplanet.org/AnarchyPlanet/anarchyplanet-site

Conflicting changes were made to the master branch on different systems. This
commit resolves the conflicts and merges them.
This commit is contained in:
sceox 2022-08-01 11:43:18 -07:00
commit f68d310cc5
2 changed files with 88 additions and 8 deletions

View File

@ -4,16 +4,85 @@ This repo includes markdown files for [the Anarchy Planet web
site](https://anarchyplanet.org/) and tools to generate a static
HTML site from the source files.
You can see this method in action at
[https://testing.anarchyplanet.org](https://testing.anarchyplanet.org).
## Contributing
If you are familiar with editing markdown and using git, you should
already be able to figure out how to contribute.
already be able to figure out how to contribute. If not, or if you need a
refresher, keep reading.
TODO: write docs for someone who's not familiar with editing markdown
and/or using git.
There are two methods for contributing: direct write, and pull request. Direct
write is best if you are already known in Anarchy Planet, and pull request is
best if you are a newcomer.
### Direct write
#### Prerequisites
You only have to do these steps once to get set up.
Register an account on https://git.anarchyplanet.org.
[Request](https://redmine.anarchyplanet.org/projects/anarchy-planet-support/issues/new)
write access to [this
repository](https://git.anarchyplanet.org/AnarchyPlanet/anarchyplanet-site).
[Install a git client](https://git-scm.com/downloads).
Configure git:
```
git config --global user.name <username>
git config --global user.email <email>
```
Clone this repository.
```
mkdir ~/projects
cd ~/projects
git clone https://git.anarchyplanet.org/AnarchyPlanet/anarchyplanet-site.git`
```
#### Making an edit
Edit the `.md` files in your preferred editor. They are written in markdown,
which comes in different flavors. You you can [get an intro to markdown
here](https://www.markdownguide.org/) or read the syntax of the markdown flavor
we use [here](https://kristaps.bsd.lv/lowdown/lowdown.5.html).
Change directory to the repository and commit your changes:
```
cd ~/projects/anarchyplanet-site
git add -p
git commit
```
When you do `git commit`, git will open an editor for you to write a commit
message. Write a short summary of the changes you made.
Push your changes:
```
git push origin master
```
All done!
### Pull request
If you don't have direct write access, you can make a pull request instead.
Follow the "Direct write" instructions, but with the following differences:
* Do not request write access. Instead, visit [this
repository](https://git.anarchyplanet.org/AnarchyPlanet/anarchyplanet-site)
in your browser and click the green fork button next to the branch label.
* When you clone, clone your fork.
* After you push your changes, visit [this
repository](https://git.anarchyplanet.org/AnarchyPlanet/anarchyplanet-site)
in your browser again and click the green pull request button next to the
branch label.
* Select the branch you made, and open the pull request.
## Dependencies
@ -27,7 +96,7 @@ describes the lanuage syntax
The rest of the heavy lifting is done by a modified version of
[ssg](https://www.romanzolotarev.com/ssg.html) which is included
in this source code.
in this source code. ssg requires a POSIX /bin/sh, and awk.
## TODOs

View File

@ -9,11 +9,22 @@ The much-loved English language library of anarchist texts and texts of
interest to anarchists. The Anarchist Library project also features
libraries in many other languages.
[Anarchy Tube](https://anarchy.tube)
A video platform hosted by anarchists that uses PeerTube technology. PeerTube
is a "free and open-source, decentralized, federated video platform." It provides
a place to watch, upload, and comment on videos and supports live streaming with
chat.
[Anarchy Planet IRC](https://irc.anarchyplanet.org)
Come chat with us through the magic of IRC ([here's a
how-to](https://anarchistnews.org/irc)).
[Anarchy Planet Jitsi](https://jitsi.anarchyplanet.chat)
A Jitsi instance for voice and video calling.
[ANews Podcast](https://podcast.anarchistnews.org)
The **only** audio source for anarchist news from the previous week.
@ -63,5 +74,5 @@ a board game or two.
[a.nti.social](https://a.nti.social/)
Anarchyplanet's free, federated social networking server built on open
Anarchy Planet's free, federated social networking server built on open
protocols! Like Twitter but better!