write some docs for how to make changes to the site

This commit is contained in:
sceox 2022-07-31 17:06:09 -07:00
parent 3b30f8f2f9
commit 80dba14010

View File

@ -4,16 +4,82 @@ 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
```
### Pull request
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