<commit_before># Contributor guidelines

These guidelines provide the general process for maintaining source code that
builds the Rackspace {{product-name}} developer documentation.

- [Project description](#project-description)
- [Updating and adding content](#updating-and-adding-content)
- [General style guidelines](#general-style-guidelines)
- [Submitting your content](#submitting-changes)
- [Previewing changes](#previewing-changes)

##Project description
<!-- Provide as little or as much information about architecture as needed to help
contributors figure out which file to update.-->

This project is developed and built by using the
[Python Sphinx documentation generator](http://sphinx-doc.org/). Content is
written in [reStructuredText](http://sphinx-doc.org/rest.html), which is the
markup syntax and parser component of
[Python Docutils](http://docutils.sourceforge.net/index.html).

Source files for the Sphinx documentation project are in the ``api-docs``
directory. Following are the key files that define project and content
architecture:

<!-- In this table, replace {{repo-name}} with the name of your repo. If you have multiple Sphinx doc projects in the same repo, replace {{folder-name}} with the name of the project folder. You'll also need to add information for both projects in this contributing document.  If you only have one project in the api-docs folder, delete {folder-name}/ from the source file URLs. -->

Content | File
--- | ---
|Index page for the main content structure| [index.rst](https://github.com/rackerlabs/{{repo.name}}/blob/master/api-docs/cloud-load-balancers-v1/index.rst)
|About the API index| [overview/index.rst](https://github.com/rackerlabs/{{repo-name}}/blob/master/api-docs/cloud-load-balancers-v1/overview/index.rst)
|Getting Started introduction| [getting-started.rst](https://github.com/rackerlabs/{{repo-name}}/blob/master/api-docs/{{folder-name}}/getting-started.rst)
|Getting Started index|[getting-started/index.rst](https://github.com/rackerlabs/{{repo-name}}/blob/master/api-docs/{{folder-name}}/getting-started/index.rst)
|Developer Guide introduction|[developer-guide.rst](https://github.com/rackerlabs/{{repo-name}}/blob/master/api-docs/{{folder-name}}/developer-guide.rst)
|Concepts section| [concepts.rst](https://github.com/rackerlabs/{{repo-name}}/blob/master/api-docs/{{folder-name}}/concepts.rst)
|General API information index|[general-api-info/index.rst](https://github.com/rackerlabs/{{repo-name}}/blob/master/api-docs/{{folder-name}}/general-api-info/index.rst)
|API Reference introduction|[api-reference.rst](https://github.com/rackerlabs/{{repo-name}}/blob/master/api-docs/{{folder-name}}/api-reference.rst)
|API Reference index|[api-operations/index.rst](https://github.com/rackerlabs/{{repo-name}}/blob/master/api-docs/{{folder-name}}/api-reference/index.rst)
|API operations methods, including code samples|[api-operations/methods](https://github.com/rackerlabs/{{repo-name}}/tree/master/api-docs/{{folder-name}}/api-reference/methods)
|Release notes|[release-notes.rst](https://github.com/rackerlabs/{{repo-name}}/blob/master/api-docs/{{folder-name}}/release-notes.rst)
|Sphinx documentation configuration file| [conf.py](https://github.com/rackerlabs/{{repo-name}}/blob/master/api-docs/{{folder-name}}/conf.py) (For new projects, replace the following values in the conf.py with values for your API project: ``product``= name of the API service, ``v#``= contract version, ``v#.r#``= ``release number``)
|Linux and OS X build script|``Makefile``|
|Windows build script|``make.bat``|



## Updating and adding content

Contributions are submitted, reviewed, and accepted by using GitHub pull<commit_msg>Updates to contributing.md<commit_after># Contributor guidelines

These guidelines provide the general process for maintaining source code that
builds the Rackspace {{product-name}} developer documentation.

- [Project description](#project-description)
- [Updating and adding content](#updating-and-adding-content)
- [General style guidelines](#general-style-guidelines)
- [Submitting your content](#submitting-changes)
- [Previewing changes](#previewing-changes)

##Project description
<!-- Provide as little or as much information about architecture as needed to help
contributors figure out which file to update.-->

This project is developed and built by using the
[Python Sphinx documentation generator](http://sphinx-doc.org/). Content is
written in [reStructuredText](http://sphinx-doc.org/rest.html), which is the
markup syntax and parser component of
[Python Docutils](http://docutils.sourceforge.net/index.html).

Source files for the Sphinx documentation project are in the ``api-docs``
directory. Following are the key files that define project and content
architecture:

**Note::** Fon new projects, update the source for this table with the information for your project. Replace {{repo-name}} with the name of your repo. If you have multiple Sphinx doc projects in the same repo, replace {{folder-name}} with the name of the project folder. You'll also need to add information for both projects in this contributing document.  If you only have one project in the ``api-docs`` folder, remove {{folder-name}}/ from the source file target URL.

Content | File
--- | ---
|Index page for the main content structure| [index.rst](https://github.com/rackerlabs/{{repo.name}}/blob/master/api-docs/{{folder-name}}/index.rst)
|Getting Started index| [getting-started/index.rst](https://github.com/rackerlabs/{{repo-name}}/blob/master/api-docs/{{folder-name}}/getting-started/index.rst.rst)
|General API information index|[general-api-info/index.rst](https://github.com/rackerlabs/{{repo-name}}/blob/master/api-docs/{{folder-name}}/general-api-info/index.rst)
|API Reference index|[api-reference/index.rst](https://github.com/rackerlabs/{{repo-name}}/blob/master/api-docs/{{folder-name}}/api-reference/index.rst)
|API operations methods, including code samples|[api-reference/methods](https://github.com/rackerlabs/{{repo-name}}/tree/master/api-docs/{{folder-name}}/api-reference/methods)
|Release notes index|[release-notes/index.rst](https://github.com/rackerlabs/{{repo-name}}/blob/master/api-docs/{{folder-name}}/release-notes/index.rst)
|Sphinx documentation configuration file| [conf.py](https://github.com/rackerlabs/{{repo-name}}/blob/master/api-docs/{{folder-name}}/conf.py) (For new projects, replace the following values in the conf.py with values for your API project: ``product``= name of the API service, ``v#``= contract version, ``v#.r#``= ``release number``)
|Linux and OS X build script|``Makefile``|
|Windows build script|``make.bat``|
|Install requirements for building locally|[requirements.txt](https://github.com/rackerlabs/docs-common/blob/master/requirements.txt)


## Updating and adding content

Contributions are submitted, reviewed, and accepted by using GitHub pull
{'fraction_non_alphanumeric': 0.1472553006099332, 'fraction_numerical': 0.0002904443799012489, 'mean_word_length': 5.472744360902255, 'pattern_counts': {'":': 0, '<': 6, '<?xml version=': 0, '>': 6, 'https://': 20, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 1, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4794987', 'n_tokens_mistral': 2089, 'n_tokens_neox': 1956, 'n_words': 546}