Skip to content
This repository has been archived by the owner on Sep 13, 2024. It is now read-only.

Latest commit

 

History

History
58 lines (37 loc) · 3.6 KB

README.md

File metadata and controls

58 lines (37 loc) · 3.6 KB
Raw

Rackspace Cloud Core Infrastructure Services User Guide

Netlify Status

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.

  • To make changes to a project, create your own fork of the repository. Then, submit a pull request 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.

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.

Note: If you want to build the project, you need to install the Sphinx documentation generator.

Source format

The Rackspace Cloud Core Infrastructure Services Guide is developed and built using the Python Sphinx documentation generator. Content is written in reStructuredText, the markup syntax and parser component of Python Docutils.

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 (Typically, this file does not require changes.)
Index page for the main content structure index.rst
User Guide introduction index cloud-guide-intro/index.rst
Cloud configuration index cloud-config/index.rst
Cloud interfaces index cloud-interfaces/index.rst
Introducing the Rackspace cloud cloud-intro/index.rst
Cloud operations index cloud-ops/index.rst
Cloud productivity index 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.

If you need additional assistance, contact us at [email protected].

Local Setup

npm i -g netlify-cli netlify init netlify build netlify dev netlify deploy