From 7ca2f24791c0b684175db0e730c359bd7b1bfb10 Mon Sep 17 00:00:00 2001 From: Justin W. Flory Date: Sep 19 2018 04:00:35 +0000 Subject: Add docs contributing guide, point to them in README --- diff --git a/.pagure/CONTRIBUTING.md b/.pagure/CONTRIBUTING.md new file mode 100644 index 0000000..8641e48 --- /dev/null +++ b/.pagure/CONTRIBUTING.md @@ -0,0 +1,51 @@ +How to contribute to D&I Team documentation +=========================================== + +Please report issues and submit pull requests for **Content Fixes** to [Fedora D&I documentation](https://docs.fedoraproject.org/en-US/diversity-inclusion/) here. +General appearance issues and publishing issues should be reported against the [publishing software](https://pagure.io/fedora-docs/docs-fp-o). + +Never done a pull request (or "PR")? +See the [GitHub Guides](https://guides.github.com/) for getting started with git. +If you already know git, see the [Pagure documentation for Pull Requests](https://docs.pagure.org/pagure/usage/pull_requests.html) on how to submit contributions on pagure.io. + + +## How to edit these documents + +Content for the D&I documentation is stored [in this repository](https://pagure.io/fedora-diversity/tree/). +Source content is written in [AsciiDoc](http://asciidoc.org/). +See these resources for help using AsciiDoc: + +* [AsciiDoc Syntax - Quick Reference](http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/) +* [AsciiDoc Recommended Practices](https://asciidoctor.org/docs/asciidoc-recommended-practices/) + + + + +## Test with a local preview + +This repo includes scripts to build and preview the contents of this repository. + +**NOTE**: Please note that if you reference pages from other repositories, those links will be broken in the local preview, as it only builds this repository. +If you want to rebuild the whole Fedora Docs site, see the [Fedora Docs build repository](https://pagure.io/fedora-docs/docs-fp-o/) for instructions. + +Both of the below scripts use Docker, so ensure Docker is installed on your system before beginning (see below for Fedora instructions). +See below for further instructions. + +To build and preview the site, run: + +```bash +./build.sh && ./preview.sh +``` + +The preview is hosted at [http://localhost:8080](http://localhost:8080). + +### Installing Docker on Fedora + +See the Fedora Developer Portal on [how to install Docker on Fedora](https://developer.fedoraproject.org/tools/docker/docker-installation.html "How to install Docker on Fedora") diff --git a/README.md b/README.md index b90397c..ddb4f5c 100644 --- a/README.md +++ b/README.md @@ -21,3 +21,8 @@ If you're looking for other places to get in contact or participate with the Div * **Mailing list**: [diversity AT lists DOT fedoraproject DOT org](https://lists.fedoraproject.org/admin/lists/diversity.lists.fedoraproject.org) * **IRC channel**: #fedora-diversity on [freenode](https://freenode.net/) [ [webchat](https://webchat.freenode.net/?channels=fedora-diversity) ] * **Telegram**: [@fedoradiversity](https://t.me/fedoradiversity) + + +## How to contribute to docs + +See [CONTRIBUTING.md](https://pagure.io/fedora-diversity/blob/master/f/.pagure/CONTRIBUTING.md).