PR#41: add a basic README.md - SSSD/docs

SSSD / docs

#41 add a basic README.md

Merged 6 years ago by jhrozek. Opened 6 years ago by jhrozek.

SSSD/ jhrozek/docs readme into master

add a basic README.md

Jakub Hrozek • 6 years ago

4a236bc

README.md

file added

+33

		`@@ -0,0 +1,33 @@`
		`+ # SSSD documentation sources`
		`+`
		`+ This repository contains the sources of the documentation of SSSD. You can`
		`+ contribute to SSSD by improving the documentation!`
		`+`
		`+ If you are looking for the rendered documentation in HTML format, please see`
		`+ the [docs link on the sssd pagure instance](https://pagure.io/docs/SSSD/sssd/).`
		`+`
		`+ ## Contributing to the SSSD documentation`
		`+`
		`+ The SSSD documentation is written in RST. To contribute to the documentation:`
		`+`
		+ 1. Make sure Sphinx is installed (`dnf install sphinx` on Fedora)
		`+ 2. Fork [this repository](https://pagure.io/SSSD/docs) on pagure`
		`+ 3. Add your content. The [sphinx documentation](http://www.sphinx-doc.org/en/stable/contents.html)`
		`+ might prove useful. If you are adding a new page, don't forget to add it to`
		`+ an index!`
		+ 4. Build the HTML pages with `make html`
		+ 5. Inspect that the result looks good. The HTML result is located in the `_build` directory
		`+ 6. Create a local commit with your changes`
		`+ 7. Push it to your pagure fork`
		`+ 8. Create a pull request`
		`+`
		`+ One of the SSSD maintainers will then review the pull request.`
		`+`
		`+ For fixing trivial issues like typos, you can also use the "Fork and edit"`
		`+ button in the [sssd docs repository](https://pagure.io/SSSD/docs) or just the`
		`+ "Edit" button in your fork.`
		`+`
		`+ ## Building the SSSD documentation`
		`+`
		`+ SSSD developers should use [this guide](https://docs.pagure.org/pagure/usage/using_doc.html)`
		`+ to convert the RST markup into HTML and push the HTML into the main SSSD repository.`

jhrozek commented 6 years ago

Just so that a) users know that this is not the documentation itself, but only its source and let them know where the docs are and b) tell people how to contribute to sssd docs.