https://github.com/rackerlabs/docs-core-infra-user-guide
User documentation source for Rackspace Cloud Core Infrastructure Services User Guide
https://github.com/rackerlabs/docs-core-infra-user-guide
Last synced: over 1 year ago
JSON representation
User documentation source for Rackspace Cloud Core Infrastructure Services User Guide
- Host: GitHub
- URL: https://github.com/rackerlabs/docs-core-infra-user-guide
- Owner: rackerlabs
- Created: 2014-05-22T20:30:08.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2023-07-25T16:21:58.000Z (almost 3 years ago)
- Last Synced: 2024-04-14T09:07:17.512Z (over 2 years ago)
- Language: HTML
- Homepage: https://developer.rackspace.com/docs/user-guides/infrastructure/
- Size: 9.74 MB
- Stars: 6
- Watchers: 29
- Forks: 27
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Rackspace Cloud Core Infrastructure Services User Guide
[](https://app.netlify.com/sites/docs-core-infra-user-guide/deploys)
## Purpose
This GitHub repository contains the source files for the Rackspace Cloud Core Infrastructure Services User Guide.
## Contributing
Contributions are welcome!
* To suggest changes or report a problem, submit an [issue](https://github.com/rackerlabs/docs-core-infra-user-guide/issues).
* To make changes to a project, create your own fork of the repository. Then, submit a [pull request](https://github.com/rackerlabs/docs-core-infra-user-guide/compare?expand=1) to have your changes reviewed and merged into the master branch as appropriate.
To contribute content, all you need is an editor and a basic understanding of the project layout and [reStructuredText syntax](http://sphinx-doc.org/rest.html).
You can use the GitHub editor or any text editor to work with documentation source files. For quick syntax checking, try the [Online reStructuredText editor](http://rst.ninjs.org/).
**Note**: If you want to build the project, you need to install the [Sphinx documentation generator](http://www.sphinx-doc.org/en/stable/install.html).
## Source format
The Rackspace Cloud Core Infrastructure Services Guide is developed and built using the [Python Sphinx documentation generator](http://sphinx-doc.org/). Content is written in [reStructuredText](http://sphinx-doc.org/rest.html), the markup syntax and parser component of [Python Docutils](http://docutils.sourceforge.net/index.html).
The repository includes the documentation source files, Sphinx configuration and build files, as well as any required Sphinx extensions and build tools.
## Structure
Source files for the Sphinx documentation project are in the main `docs-core-infra-user-guide` directory. Following are the key files that define the Spinx project and content architecture for the documentation:
| Content | File |
|---|---|
| Sphinx documentation configuration file | [conf.py](https://github.com/rackerlabs/docs-core-infra-user-guide/blob/master/conf.py) (Typically, this file does not require changes.) |
| Index page for the main content structure | [index.rst](https://github.com/rackerlabs/docs-core-infra-user-guide/blob/master/index.rst) |
|User Guide introduction index | [cloud-guide-intro/index.rst](https://github.com/rackerlabs/docs-core-infra-user-guide/blob/master/cloud-guide-intro/index.rst) |
| Cloud configuration index | [cloud-config/index.rst](https://github.com/rackerlabs/docs-core-infra-user-guide/blob/master/cloud-config/index.rst) |
| Cloud interfaces index | [cloud-interfaces/index.rst](https://github.com/rackerlabs/docs-core-infra-user-guide/blob/master/cloud-interfaces/index.rst) |
| Introducing the Rackspace cloud | [cloud-intro/index.rst](https://github.com/rackerlabs/docs-core-infra-user-guide/blob/master/cloud-intro/index.rst) |
| Cloud operations index | [cloud-ops/index.rst](https://github.com/rackerlabs/docs-core-infra-user-guide/blob/master/cloud-ops/index.rst) |
| Cloud productivity index | [cloud-preprod/index.rst](https://github.com/rackerlabs/docs-core-infra-user-guide/blob/master/cloud-preprod/index.rst) |
| **make.bat** | Windows build script |
| **Makefile** | Linux and OS X build |
## Support and feedback
If you find a problem, open a GitHub [issue](https://github.com/rackerlabs/docs-core-infra-user-guide/issues).
If you need additional assistance, contact us at .
## Local Setup
`npm i -g netlify-cli`
`netlify init`
`netlify build`
`netlify dev`
`netlify deploy`