Git Product home page Git Product logo

docs-cloud-files's Introduction

Rackspace Cloud Files API documentation

Build Status

Purpose

This GitHub repository contains the source files for the following Rackspace Cloud Files API documentation:

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 developer documentation 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 any required Sphinx extensions and build tools.

Structure

Source files for the Sphinx documentation project are in the api-docs directory. Here are the key files that define the Sphinx 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
About the API index overview/index.rst
Getting Started introduction getting-started.rst
Getting Started index getting-started/index.rst
Developer Guide introduction developer-guide.rst
Concepts section concepts.rst
General API information index general-api-info/index.rst
API Reference introduction api-reference.rst
API Reference index for storage operations storage-api-operations/index.rest
API Reference index for CDN operations cdn-api-operations/index.rst
API operations methods for storage, including code samples storage-api-operations/methods
API operations methods for CDN, including code samples cdn-api-operations/methods
Special Use Cases introduction use-cases-information.rst
Static websites using CDN-enabled containers static-websites-using-cdn-enabled-containers/index.rst
Bulk operations bulk-operations/index.rst
Public access to your Cloud Files account public-access-to-your-cloud-files-account/index.rst
Release notes release-notes.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].

docs-cloud-files's People

Contributors

cyrichardson avatar dshendler avatar lauracly avatar meker12 avatar reneerendon avatar smashwilson avatar sharwell avatar michael-mcgrail-rackspace avatar catlook avatar dian4554 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.