Code Monkey home page Code Monkey logo

docs-cloud-files's Introduction

Rackspace Cloud Files API documentation

Resources

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

Contributing

Contributions are welcome! To suggest changes to the documentation, submit an issue or a pull request.

To make changes to a project, create your own fork of the project and send a pull request to have your changes reviewed and merged into the master branch as appropriate.

Building from Source

This repository uses Maven to generate the output documentation. Command line users can generate the complete output from this repository by using the following command:

mvn clean generate-sources

The output appears in PDF and HTML form in the following locations. The items in the Name column link to the location where the documentation is published, when available.

Name Build Location
Getting Started Guide target/docbkx/webhelp/cf-getting-started-external
Developer Guide target/docbkx/webhelp/cf-devguide-external
Release Notes target/docbkx/webhelp/cf-releasenotes-external

Editors

You can use any text editor to work with these source files. If you want to use an IDE, consider NetBeans. This cross-platform IDE offers seamless support for Maven projects and does not require additional configuration to open the pom.xml file as a project. You can configure the project so that the Build command, which appears when you right-click a project in the Projects pane, executes the clean generate-sources command. To do so, perform the following steps:

  1. Right-click the project in the Projects pane and select Properties.
  2. Select the Build category in the left pane, and then select the Build project action in the right pane.
  3. Change Execute Goals to clean generate-sources.
  4. (Optional) Repeat steps 2 and 3 for the Clean and Build project and Build with Dependencies actions.

Quick Links

The files that are most likely to be of interest to you are as follows:

If you want to make changes to the example files referenced in the WADL file, you can find the example files at src/wadl/samples.

The status codes referenced by the WADL files are at src/resources/wadl/common.ent.

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.