Git Product home page Git Product logo

p0pr0ck5 / dreamcloud-docs Goto Github PK

View Code? Open in Web Editor NEW

This project forked from rob-pait/dreamcloud-docs

1.0 2.0 0.0 30.61 MB

Documentation for users of all DreamHost Cloud products (DreamCompute, DreamObjects, etc). Aimed at developers who wish to learn how to use DreamHost Cloud standard APIs (based on OpenStack) to automate common tasks.

Home Page: https://www.dreamhost.com/cloud

License: Creative Commons Attribution Share Alike 4.0 International

Shell 46.50% Python 53.50%

dreamcloud-docs's Introduction

Documentation for DreamHost Cloud products

Documentation for users of all DreamHost Cloud products (DreamCompute, DreamObjects, etc). Aimed at developers who wish to learn how to use DreamCloud standard APIs to automate common tasks.

Build Status

The documentation is organized by product and level of knowledge required to understand the documentation, stored in the source/ directory in sphinx formatted files. The source/ dir contains subdirs, one for each of DreamCloud products and subdirs to group articles based on depth of knowledge required by readers:

  • dreamcompute
    • gettingstarted
    • tutorials
    • api-docs
  • dreamobjects
    • gettingstarted
    • tutorials
    • api-docs

note: some of the directories above are empty and the content you see in the Knowledge Base comes from other sources, like upstream OpenStack docs forked by DreamHost and published automatically.

Building the Documentation

run tox in the repo to build the documentation, the build directories are in build/html/$category/$section/$article. For example, the dreamcompute tutorials documentation will be built to "build/html/dreamcompute/tutorials/"

How to contribute

Fork the repository, modify or add articles, run tox for basic syntax checks and verify the built html locally before committing. Once you're satisfied with the local results, create a pull request.

Gotchas of contributing

If you change a title of an article, you must first change it in the Knowledge Base, this is because the publishing script compares articles by title and it will create a new article with the new title if you dont change the article title in the Knowledge Base.

Publishing to DreamHost Knowledge Base

The built html files are automatically published via Jenkins job to (DreamHost Knowledge Base)[https://help.dreamhost.com] once merged to master.

Hacks we have to make things pretty

  • If you create a TOC with labels using :ref: to refer to them, insert the TOC in '.. container:: table_of_content' and the Headers associated with each item in the TOC will remain at the top of the screen as you scroll past them

Styleguide

Check the styleguide.rst for style requirements

Automation

Things the script does:

  • Publish articles in the "source" directory (excluding things in the "common" directory)
  • Adds labels to the article in Zendesk from the rst meta
  • Puts the article in the section specified in the "section_id" file in the same directory as the rst file

Things the script does not do:

  • Rename articles in zendesk when their titles change
  • Delete articles that have been deleted from this git repo

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.