site/wiki/README.md

57 lines
1.3 KiB
Markdown
Raw Permalink Normal View History

2018-06-04 02:18:02 +00:00
# tilde.team wiki
hi there, welcome to our wiki!
to contribute to the wiki:
2018-09-07 16:58:58 +00:00
* [fork the repo](https://tildegit.org/repo/fork/1)
2018-08-08 17:09:33 +00:00
* clone the repo to your local machine (or your public_html folder on the tilde.team box for live testing)
2018-06-04 02:18:02 +00:00
```sh
2018-09-07 16:58:58 +00:00
git clone https://tildegit.org/yourusername/site
2018-06-04 02:18:02 +00:00
```
* create a new branch for your page
```sh
git checkout -b my-new-page
```
* if you want to add a new page, copy `template.md` into your new page!
```sh
cp template.md my-new-page.md
```
* edit as needed!
2019-07-03 03:28:07 +00:00
* test your changes with a local php server
```sh
composer install
php -S localhost:9000
```
2018-09-07 16:58:58 +00:00
* commit your changes and [create a pull request](https://tildegit.org/team/site/pulls) :)
2018-06-04 02:18:02 +00:00
```sh
git add --all
git commit -m "added my-new-page"
git push origin my-new-page # this should match the branch name you created earlier
```
2018-09-07 16:58:58 +00:00
* create a pull request on the [site](https://tildegit.org/team/site) repo
2018-06-04 02:18:02 +00:00
2019-07-05 16:19:12 +00:00
## deployment notes
as of a7305c7b the wiki uses pretty urls (while still supporting the old style
of `?page=` urls). to enable this functionality, add the following location
block to your nginx configs for this site:
```
location ~* ^/wiki/(.+)$ {
try_files $uri $uri/ /wiki/index.php?page=$1;
include snippets/php.conf;
}
```
2018-06-04 02:18:02 +00:00
thanks!~
ps. if you have any questions, ask on irc! (preferably in #team)